正文

C++/C代码审查表(一)2007-04-11 22:07:00

【评论】 【打印】 【字体: 】 本文链接:http://blog.pfan.cn/lym51/24809.html

分享到:

 

文件结构

重要性

审查项

结论

 

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

 

 

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

 

 

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

 

重要

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

 

 

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

 

 

……

 

程序的版式

重要性

审查项

结论

 

空行是否得体?

 

 

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

 

 

长行拆分是否得体?

 

 

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

 

重要

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

 

重要

Ifforwhiledo等语句自占一行,不论执行语句多少都要加“{}”。

 

重要

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

 

 

注释是否清晰并且必要?

 

重要

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

 

重要

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

 

 

……

 

命名规则

重要性

审查项

结论

重要

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

 

 

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

 

 

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

 

重要

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

 

 

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

 

 

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

 

阅读(2327) | 评论(0)


版权声明:编程爱好者网站为此博客服务提供商,如本文牵涉到版权问题,编程爱好者网站不承担相关责任,如有版权问题请直接与本文作者联系解决。谢谢!

评论

暂无评论
您需要登录后才能评论,请 登录 或者 注册