首页 电脑 电脑学堂 查看内容

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

2004-9-29 20:05 752 0

摘要: 附录A :C++/C代码审查表文件结构重要性审查项结论头文件和定义文件的名称是否合理?头文件和定义文件的目录结构是否合理?版权和版本声明是否完整?重要头文件是否使用了 ifndef/define/en...
关键词: 变量 重要 语句 表达式 文件 重要性 结论 得体 代码 标识符

附录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 语句时是否留下隐患? 例如跳过了某些对象的构造、变量的初始化、重要的计算等。……常量重要性审查项
声明:文章版权归原作者所有 部分文章转自互联网 如有侵权请联系 [邮箱地址] 删除

路过

雷人

握手

鲜花

鸡蛋

最新评论

返回顶部