文章摘要: 整理一份必须遵守的规则和指南,确保代码的可靠性、可维护性、可扩展性,可以想象成是代码的“语法”和“逻辑”。
注释
- 关注代码的结构、设计和实现。例如,代码组织方式、模块化、函数长度、错误处理、代码复用、测试要求、安全实践等。
- 通常具有更强的约束性,需要团队成员严格遵守。违反规范可能会导致代码缺陷、安全隐患、维护困难等问题。
文件使用“UTF-8”编码格式
- 统一使用相同的文件编码格式,防止文件编码错误。
类和函数的注释要以javadoc的方式来写
- 方便在后续自动生成开发者文档。
代码组织
- 保持方法简短,每个方法只做一件事情。
- 使用适当的访问修饰符,私有方法应该用于辅助逻辑。
流程控制
嵌套不要超过3层
- 提高可读性。
异常处理
使用 try-with-resources 语句来自动管理资源
- 减少代码冗余。
try (Resource resource = new Resource()) {
// 使用资源
} catch (Exception e) {
// 处理异常
}