文件结构 |
||
重要性 |
审查项 |
结论 |
|
头文件和定义文件的名称是否合理? |
|
|
头文件和定义文件的目录结构是否合理? |
|
|
版权和版本声明是否完整? |
|
重要 |
头文件是否使用了 ifndef/define/endif 预处理块? |
|
|
头文件中是否只存放“声明”而不存放“定义” |
|
|
…… |
|
程序的版式 |
||
重要性 |
审查项 |
结论 |
|
空行是否得体? |
|
|
代码行内的空格是否得体? |
|
|
长行拆分是否得体? |
|
|
“{” 和 “}” 是否各占一行并且对齐于同一列? |
|
重要 |
一行代码是否只做一件事?如只定义一个变量,只写一条语句。 |
|
重要 |
If、for、while、do等语句自占一行,不论执行语句多少都要加“{}”。 |
|
重要 |
在定义变量(或参数)时,是否将修饰符 * 和 & 紧靠变量名? |
|
|
注释是否清晰并且必要? |
|
重要 |
注释是否有错误或者可能导致误解? |
|
重要 |
类结构的public, protected, private顺序是否在所有的程序中保持一致? |
|
|
…… |
|
命名规则 |
||
重要性 |
审查项 |
结论 |