【XXXX项目】代码审查报告

《【XXXX项目】代码审查报告》由会员上传分享，免费在线阅读，更多相关内容在工程资料-天天文库。

1、代码审查报告检查人：检查tl期：年M日审查内容：请填写执行代码审查的系统名称审查结果：通过口不通过口说明：请填写执行代码审查的系统功能总则条款执行情况说明1排版U-1：程序块要采用缩进风格编写，缩进由4个空格组成。是［］否［］免［］*1-2：相对独立的程序块之间、变量说明之后必须加空行。是［］否［］免［］U-3：较长的语句（>80字符）要分成多行书写，长表达式要在低优先级操作符处划分新行，操作符放在新行Z首，划分出的新行要进行适当的缩进，使排版整齐，语句可读。是［］否［］免［］•1-4：循环、判断等

2、语句中若冇较长的表达式或语句，则要进行适应的划分，长表达式要在低优先级操作符处划分新行，操作符放在新行Z首。是［］否［］免［］*1-5：若函数或过程中的参数较长，则要进行适当的划分。是［］否［］免［］U-6：不允许把多个短语句写在一行中，即一行只写一条语句。是［］否［］免［］11-7：ifwhile、for^defaultdo等语句自占一行。是［］否［］免［］4-8：对齐只使用TAB键，不使用空格键。是［］否［］免［］*1-9：函数或过程的开始、结构的定义及循环、判断等语句中的代码都要采用缩进风格，

3、case语句下的情况处理语句也耍遵从语句缩进耍求。是［］否［］免［］4-10：程序块的分界符（如C/C++语言的大括号'{'和'}'）应各独占一行并且位于同一列，同时与引用它们的语句左对齐。在函数体的开始、类的定义、结构的定义、枚举的定义以及if、for>do>while、switch、case语句中的程序都要采用如上的缩进方式。是［］否［］免［］*1-11：在两个以上的关键字、变量、常量进行对等操作时，它们之间的操作符Z前、Z后或者前后要加空格；进行非对等操作时，如果是关系密切的立即操作符（如一>

4、）,后不应加空格。是［］否［］免［］2注释*2-1：一般情况下，源程序有效注释量必须在20%以上。是［］否［］免［］■2-2：说明性文件（如头文件.h文件、.inc文件、.def文件、编译说明文件.cf^等）头部应进行注释，注释必须列出：版权说明、版本号、生成日期、作者、内容、功能、与其它文件的关系、修改日志等，头文件的注释屮还应有函数功能简要说明。是［］否［］免［］■2-3：源文件头部应进行注释，列出：版权说明、版本号、生成日期、作者、模块目的/功能、主要萌数及其功能、修改日志等。是［］否［］免［

5、］*2-4：函数头部应进行注释，列岀：函数的H的/功能、输入参数、输出参数、返回值、调用关系（函数、表）等。是［］否［］免［］>2-5：边写代码边注释，修改代码同时修改相应的注释，以保证注释与代码的一致性。不再有用的注释要删除。是［］否［］免［］'2-6：注释的内容要淸楚、明了，含义准确，防止注释二义性。是［］否［］免［］总则条款执行情况说明»2-7：避免在注释中使用缩写，特别是非常用缩写。是［］否［］免［］>2-8：注释应与其描述的代码相近，对代码的注释应放在英上方或右方（对单条语句的注释）相邻位

6、置，不可放在下而，如放于上方则需与其上而的代码用空行隔开。是［］否［］免［］*2-9：对于所冇冇物理含义的变量、常量，如果其命名不是充分自注释的，在声明时都必须加以注释，说明英物理含义。变量、常量、宏的注释应放在英上方相邻位置或右方。是［〔否［〔免［］'2-10：数据结构声明（包括数组、结构、类、枚举等），如果其命名不是充分自注释的，必须加以注释。对数据结构的注释应放在英上方相邻位置，不可放在下面；对结构小的每个域的注释放在此域的右方。是［］否［］免［］*2-11：全局变量要有较详细的注释，包括对其

7、功能、取值范禺、哪些函数或过程存取它以及存取时注怠事项等的说明。是［］否［］免［］】2-12：注释•与所描述内容进行同样的缩排。是［］否［］免［］'2-13：将注释与其上血的代码用空行隔开。是［］否［］免［］■2-14：对变量的定义和分支语句（条件分支、循环语句等）必须编写注释。是［］否［］免［］'2-15：对于switch语句下的case语句，如果因为特殊情况需要处理完一个case后进入下一个case处理，必须在该case语句处理完、下一个case语句前加上明确的注释。是［］否［］免［］3标识符命

8、名*3-1：标识符的命名要清晰、明了，有明确含义，同时使用完整的单词或人家基本可以理解的缩写，避免使人产生误解。是［］否［］免［］】3-2：命名中若使用特姝约定或缩写，则要冇注释说明。是［］否［］免［］*3-3：白己特有的命名风格，要白始至终保持一致，不可来回变化。是［］否［］免［］】3-4：对于变最命名，禁止取单个字符（如i、j、k...）,建议除了要有具体含义外，还能表明英变量类型、数据类型等，但i、j、k作局部循环变量是允许的。是［］否［］免［］临-5：命名规范