C_and_CPP 版 (精华区)

发信人: xuxian (呵呵), 信区: C_and_CPP
标  题: appendix A
发信站: 哈工大紫丁香 (Tue Sep  9 12:44:42 2003)


高质量C++/C编程指南（附录A）

------------------------------------------------------------------------------
--

2002年08月08日 21:39:27 www.fanqiang.com  
 
附录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 语句时是否留下隐患? 例如跳过了某些对象的构造、变量的初始化、重要的计
算等。   
 
 ...   
 

--
锦瑟
锦瑟无端五十弦，一弦一柱思华年。
庄生晓梦迷蝴蝶，望帝春心托杜鹃。
沧海月明珠有泪，蓝田日暖玉生烟。
此情可待成追忆，只是当时已惘然。


※ 来源:．哈工大紫丁香 bbs.hit.edu.cn [FROM: 202.118.4.238]