内部资料 注意保密
Java 编码规范与指南
目录
1 导言........................................................................................................1
2 标识符命名............................................................................................1
2.1.1 标识符的命名要清晰、明了，有明确含义..................................................................1
2.1.2 采用该领域的术语..........................................................................................................1
2.1.3 大小写约定......................................................................................................................1
2.1.4 少用缩写..........................................................................................................................2
2.1.5 避免使用长的名字（15 字符以内）.............................................................................2
2.1.6 避免使用仅在大小写上有差异的命名..........................................................................2
2.1.7 对首字母缩写词的使用..................................................................................................2
2.1.8 下划线的使用..................................................................................................................2
3 格式规范................................................................................................5
3.1.1 { } 对.................................................................................................................................5
3.1.2 圆括号..............................................................................................................................5
3.1.3 缩进..................................................................................................................................6
3.1.4 空白行..............................................................................................................................6
3.1.5 空格..................................................................................................................................6
3.1.6 页宽..................................................................................................................................7
3.1.7 折行..................................................................................................................................7
3.1.8 JAVA 注释语句类型........................................................................................................8
3.1.9 快速浏览 JAVADOC......................................................................................................8
3.1.10 按目的分的注释类型....................................................................................................9
4 文件规范................................................................................................9
4.1.1 文件名............................................................................................................................10
4.1.2 版本信息........................................................................................................................10
4.1.3 变更记录........................................................................................................................10
4.1.4 版权声明........................................................................................................................10
4.1.5 变量定义.........................................................................................................................11
4.1.6 方法定义........................................................................................................................12
4.1.7 语句................................................................................................................................13
5 应用规范..............................................................................................16
6 最佳实践..............................................................................................18
7 日志输出..............................................................................................20
