收藏本站 收藏本站
积木网首页 - 软件测试 - 常用手册 - 站长工具 - 技术社区
积木学院 > 黑客技术 > 黑客编程 > 正文

高质量C++/C编程指南 -- 附录A :C++/C代码审查表

来源:互联摘选 日期:2007-12-04 18:43
附录A :C++/C代码审查表
文件结构

重要性
审查项
结论


头文件和定义文件的名称是否合理?



头文件和定义文件的目录结构是否合理?



版权和版本声明是否完整?


重要
头文件是否使用了 ifndef/define/endif 预处理块?



头文件中是否只存放“声明”而不存放“定义”



……


程序的版式

重要性
审查项
结论


空行是否得体?



代码行内的空格是否得体?



长行拆分是否得体?



“{” 和 “}” 是否各占一行并且对齐于同一列?


重要
一行代码是否只做一件事?如只定义一个变量,只写一条语句。


重要
If、for、while、do等语句自占一行,不论执行语句多少都要加“{}”。


重要
在定义变量(或参数)时,是否将修饰符 * 和 & 紧靠变量名?



注释是否清晰并且必要?


重要
注释是否有错误或者可能导致误解?


重要
类结构的public, protected, private顺序是否在所有的程序中保持一致?



……


命名规则

重要性
审查项
结论

重要
命名规则是否与所采用的操作系统或开发工具的风格保持一致?



标识符是否直观且可以拼读?



标识符的长度应当符合“min-length && max-information”原则?


重要
程序中是否出现相同的局部变量和全部变量?



类名、函数名、变量和参数、常量的书写格式是否遵循一定的规则?



静态变量、全局变量、类的成员变量是否加前缀?



……


表达式与基本语句

重要性
审查项
结论

重要
如果代码行中的运算符比较多,是否已经用括号清楚地确定表达式的操作顺序?



是否编写太复杂或者多用途的复合表达式?


重要
是否将复合表达式与“真正的数学表达式”混淆?


重要
是否用隐含错误的方式写if语句? 例如

(1)将布尔变量直接与TRUE、FALSE或者1、0进行比较。

(2)将浮点变量用“==”或“!=”与任何数字比较。

(3)将指针变量用“==”或“!=”与NULL比较。



如果循环体内存在逻辑判断,并且循环次数很大,是否已经将逻辑判断移到循环体的外面?


重要
Case语句的结尾是否忘了加break?


重要
是否忘记写switch的default分支?


重要
使用goto 语句时是否留下隐患? 例如跳过了某些对象的构造、变量的初始化、重要的计算等。



……


常量

重要性
审查项

推荐阅读

 

热点信息

 
强悍的草根IT技术社区,这里应该有您想要的!
Copyright © 2010 Gimoo.Net. All Rights Rreserved  京ICP备05050695号