- 27
- 0
- 约5.79千字
- 约 31页
- 2020-11-25 发布于山东
- 举报
代码审查报告
公司
版本信息
文档标识: 当前版本:
草稿
当前状态: 发布日期:
发布
修改历史
版
变更控制
日期
作者
修改内容
评审号
本
号
评
审
对
象
审查员
项
目
名
审查日期
称
分 重要
检查项 备注
类 性
命
名
成员变量,方法参数等需要使用首
字母小写,
其余单词首字母大写的命名方式,
命名规则是否与所采用
重要
禁止使用下划线 (_) 数字等方式命
的规范保持一致?
名
不要出现局部变量,成员变量大写
字母开头等问题
各种命名尽可能短,表意准确,除
是否遵循了最小长度最
一般 2 代替‘ to ’,多信息原则?
4 代替‘ for ’外, 不建议使用数字
has/can/is 前缀的函数
重要
是否返回布尔型?
类名是否存在重名问
重要
题?
在命名中
成员变量,方法参数,局部变量等
为布尔型时,
如果出现 has/can/is 开头,则将这些词去掉
自己实现的类尽量不要和别人的类重名,
尽管不在同一个包下,特别是子类
和父类重名的情况
注
释
方法 JAVADOC注释中需要说明各参
数、返回值
注释是否较清晰且必
重要
要?
及异常说明,参数说明需按照参数
名称及用意对应标注
复杂的分支流程是否已
重要
经被注释?
距离较远的 } 是否已经被
一般
注释?
文件,类(含接口,枚举等),成
函数是否已经有文档注
员
您可能关注的文档
- 人教版本小学一年级的语文下册的第6单元复习测试卷试题.docx
- 人教版本小学一年级语文下册的《写字数标准表格》生字数组词.docx
- 人教版本小学一年级语文下册的月考试卷试题.docx
- 人教版本小学三年级下册的英语期初中中考试测试卷习题..docx
- 人教版本小学三年级下册的语文期末试卷习题.docx
- 人教版本小学三年级的上册的数学学习知识点学习归纳总结计划.docx
- 人教版本小学二年级下册的数学学习复习总结计划练练习习题.docx
- 人教版本小学二年级的上册的数学学习知识点学习归纳总结计划.docx
- 人教版本小学五年级上册的数学期末考试试卷习题及答案.docx
- 人教版本小学五年级下阅读理解专项训练含答案.docx
原创力文档

文档评论(0)