- 10
- 0
- 约3.23千字
- 约 5页
- 2022-11-19 发布于上海
- 举报
附录 C :C++/C 代码审查表
文件结构重要性
重要
审查项 结论
头文件和定义文件的名称是否合理?
头文件和定义文件的目录结构是否合理? 版权和版本声明是否完整?
头文件是否使用了 ifndef/define/endif 预处理块 ?
头文件中是否只存放“声明”而不存放“定义”
……
程序的版式重要性
空行是否得体?
审查项 结论
代码行内的空格是否得体? 长行拆分是否得体?
“{” 和 “}” 是否各占一行并且对齐于同一列?
重要 一行代码是否只做一件事?如只定义一个变量,只写一条语句。
重要 If、for、while 、do 等语句自占一行,不论执行语句多少都要加“ {}”。
重要 在定义变量(或参数)时,是否将修饰符 * 和 & 紧靠变量名?
注释是否清晰并且必要?
重要重要
命名规则重 要 性 重要
注释是否有错误或者可能导致误解?
类结构的 public, protected, private 顺序是否在所有的程序中保持一致?
……
审查项 结论
命名 规则 是否与 所采 用的操 作系 统或 开发工 具的 风格保持一致?
标识符是否直观且可以拼读?
标 识 符 的 长 度 应 当 符 合 “ min-length max-information ”原则?
重要 程序中是否出现相同的局部变量和全部变量?
类名、函数名、变量和参数、常量的书写格式是否遵循一
原创力文档

文档评论(0)