Java编码规范(一)

命名规范

项目名：各单词首字母大写，其它字母小写

包名：全部字母小写且唯一，通常为公司域名的倒序

源文件名：各单词首字母大写，其它字母小写

方法名：第一个单词全部小写，其余单词首字母大写，其它字母小写，一般应为动词

成员变量名：第一个单词全部小写，其余单词首字母大写，其它字母小写

成员常量名：所有单词大写，单词之间用下划线(_)连接

 

源文件大小

尽量不超过2000行(以每行长度不超过80个字符计)，否则有类臃肿之嫌，在类设计时应尽量避免

 

源文件结构

文件注释头：用来描述该类的功能及特点，以及相关开发维护信息，如类功能概述、关联类(@see)(不包括系统类)、该类所支持的JDK版本(@since)、作者(@author)、创建日期(@date)、修改历史(包括修改人、修改日期、审查人)、该类版本(@version)、版权信息。

包名(package)

导入声明(import)

类和接口的声明部分

 

注释

数据结构和方法前应用块注释

当注释行过多且更改频繁时，也应考虑使用块注释