代码规范1
需积分: 0 53 浏览量
2022-08-08
21:19:55
上传
评论
收藏 25KB DOCX 举报
代码规范:
分类
重要性
检查项
备注
命名
重要
命名规则是否与所采
用的规范保持一致？
成员变量，方法参数
等需要使用首字母小
写，其余单词首字母
大写的命名方式，禁
止使用下划线(_)数
字等方式命名
不要出现局部变量，
成员变量大写字母开
头等问题
一般
是否遵循了最小长度
最多信息原则？
各种命名尽可能短，
表意准确，除 2 代替
‘to’，4 代替
‘for’外，不建议使
用数字在命名中
重要
has/can/is 前缀的
函数是否返回布尔
型？
成员变量，方法参数，
局部变量等为布尔型
时，如果出现 has/ca
n/is 开头，则将这些
词去掉
重要
类名是否存在重名问
题？
自己实现的类尽量不
要和别人的类重名，
尽管不在同一个包下，
特别是子类和父类重
名的情况
注释
重要
注释是否较清晰且必
要？
方法 JAVADOC 注释中
需要说明各参数、返
回值及异常说明，参
数说明需按照参数名
称及用意对应标注
重要
复杂的分支流程是否
已经被注释？
一般
距离较远的}是否已
经被注释？
重要
函数是否已经有文档
注释？（功能、输入、
返回及其他可选）
文件，类（含接口，
枚举等），成员变量，
方法前需要有 JAVAD
OC 的注释
一般
特殊用法是否被注
释？
声明、空白、缩进
一般
每行是否只声明了一
评论0