- 8
- 0
- 约1.48万字
- 约 13页
- 2021-04-10 发布于湖北
- 举报
代码审查报告
xxxx 公司
版本信息
文档标识: 当前版本:
草稿
当前状态: 发布日期:
发布
修改历史
变更控制
日期 版本 作者 修改内容 评审号
号
评 审查员
审
对
象
项 审查日期
目
名
称
分
重要性 检查项 备注
类
命
名
成员变量,方法参数等需要使用首字母小写,
其余单词首字母大写的命名方式,
命名规则是否与所采用的规范保
重要 禁止使用下划线 (_) 数字等方式命名
持一致?
不要出现局部变量, 成员变量大写字母开头等问
题
是否遵循了最小长度最多信息原 各种命名尽可能短,表意准确,除 2 代替 ‘to,’
一般
则? 4 代替 ‘for外,不建议使用数字在命名中’
has/can/is 前缀的函数是否返回 成员变量,方法参数,局部变量等为布尔型时,
重要
布尔型? 如果出现 has/can/is 开头,则将这些词去掉
自己实现的类尽量不要和别人的类重名,
重要 类名是否存在重名问题? 尽管不在同一个包下, 特别是子类和父类重名的
情况
注
释
方法 JAVADOC 注释中需要说明各参数、 返回值
重要 注释是否较清晰且必要? 及异常说明, 参数说明需按照参数名称及用意对
应标注
复杂的分支流程是否已经被注
重要
释?
一般 距离较远的 }是否已经被注释?
函数是否已经有文档注释?(功 文件,类(含接口,枚举等),成员变量,
重要
能、输入、返回及其他可选) 方法前需要有 JAVADOC 的注释
一般 特殊用法是否被注释?
声
明、
空
白、
缩
进
您可能关注的文档
- 大雅河水利枢纽工程计量与支付监理实施细则(27P).pdf
- 大一第二学期高数论文.pdf
- 大一高数必考点及难点.pdf
- 大众汽车传感器的检测与维修.pdf
- 代理成本的形成与控制.pdf
- 代理工商注册委托合同.pdf
- 担保有限公司担保审批权限规定.pdf
- 弹簧测力计可以倒过来调零吗.pdf
- 蛋白酶的分类及作用位点.pdf
- 2025-2026学年湖南省高二(上)期末物理试卷(含答案).docx
- 2025-2026学年天津市和平区高三(上)期末数学试卷(含解析).pdf
- 2025-2026学年云南省楚雄州高三(上)期末数学试卷(含答案).pdf
- 2025-2026学年甘肃省天水市张家川实验中学高三(上)期末数学试卷(含答案).docx
- 2025-2026学年福建省厦门市松柏中学高二(上)期末数学试卷(含答案).docx
- 2025-2026学年广西钦州市高一(上)期末物理试卷(含答案).docx
- 2025-2026学年河北省邯郸市临漳县九年级(上)期末化学试卷(含答案).docx
- 2025-2026学年河北省石家庄二十三中七年级(上)期末历史试卷(含答案).docx
- 2025-2026学年海南省五指山市九年级(上)期末化学试卷(含答案).docx
- 2025-2026学年河北省唐山市玉田县九年级(上)期末化学试卷(含答案).docx
- 2025-2026学年河北省邢台市市区九年级(上)期末化学试卷(含答案).docx
原创力文档

文档评论(0)