【XXXX项目】代码审查报告

1、代码审阅报告检验员：_ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _检查日期：_ _ _ _ _ _ _ _ _月_ _ _ _ _日审阅内容：执行_ _代码审阅的系统名称_ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _审查结果：通过未通过说明：_ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ u总则执行情况说明第一排1-1:程序块必须以缩进样式编写，缩进由4个空格组成。是否免费1-2:在相对独立的程序块之间，应在变量

2、说明后添加空行。是否免费1-3:长语句(80个字符)要分成多行写，长表达式要由低优先级运算符分新行写，运算符放在新行的开头，分的新行要适当地缩进，排版要整齐，语句要可读。是否免费1-4:在循环、判断等语句中，如果有较长的表达式或语句，则将其有效地拆分，较长的表达式从低优先级运算符拆分新行，运算符位于新行的开头。是否免费1-5:如果函数或进程的参数很长，则进行相应的划分。是否免费1-6:一行不能写几个短语句。也就是说，每行不能只写一个语句。是否免费1-7: if、while、for、default、do等语句从一行开始。是否免费1-8:仅使用TAB键进行排序，不使用空格键。是否免费1-9:函数或

3、过程的开始、结构定义和循环、判断等语句中的代码必须采用缩进格式，对于case语句，必须遵循语句的缩进要求。是否免费1-10:程序块中的分界符号(如C/C语言中的花括号“”和“”)必须单独位于同一列中(每行一个)，并与引用它们的语句左对齐。函数体开始、类定义、结构定义、枚举定义和if、for、do、while、switch、case语句中的程序将如上所示缩进。是否免费1-11:当两个或多个关键字、变量、常量相等时，在它们之间的运算符之前、之后或前后放置空格。执行非对等操作时，对于关系密切的立即操作符(例如-)，不应在后面加空格。是否免费注释22-1:通常，源程序有效注释量应大于20%。是否免费2

4、-2:头文件。h文件，Inc文件，def文件，编译说明文件。注释文件(如CFG)必须注释头部，注释还必须对函数功能进行简要说明，包括版权说明、版本号、创建日期、作者、内容、功能、与其他文件的关系、修改日志、标题文件的注释。是否免费2-3:源文件的头应包含版权说明、版本号、创建日期、作者、模块目的/功能、主要功能和功能、修改日志等注释。是否免费2-4:必须注释函数头，如函数的目的/功能、输入参数、输出参数、返回值、调用关系(函数、表)等。是否免费2-5:创建边缘注释，修改代码，同时修改相应的注释以确保注释和代码的一致性。不再有用的注释将被删除。是否免费2-6:注释内容要明确、明确、意义正确，防止

5、注释异议性。是否免费2-7:不要在注释中使用缩写，尤其是不经常使用的缩写。是否免费2-8:注释应类似于所描述的代码，对代码的注释应位于其上或右侧(对单个语句的注释)旁边，不应位于下面，如果位于上面，则应使用上面的代码和空行分隔。是否免费2-9:所有具有物理意义的变量，对于常量，如果其名称不是完全注释，那么在声明时必须注释并说明其物理意义。变量、常量、宏的注释必须位于其上方相邻的位置或右侧。是否免费2-10:数据结构声明(包括数组、结构、类、枚举等)，如果其名称没有完全自描述，则需要注释。数据结构的注释必须与其上方相邻，且不能位于下方。结构中每个域的说明位于此域的右侧。是否免费2-11:全局变量

6、需要更详细的说明，包括对其功能、值范围、要访问的函数或进程、访问时的注意事项等的说明。是否免费2-12:说明缩排与说明相同。是否免费2-13:用空行分隔注释及其上方的代码。是否免费2-14:变量的定义和分支语句(条件分支、循环语句等)需要注释。是否免费2-15:对于switch语句下的case语句，在特殊情况下，必须处理一个case，然后进入下一个case处理，因此必须处理case语句，并在下一个case语句之前添加明确的注释。是否免费指定3标识符名称3-1:标识符的名称不仅要有明确、明确、明确的含义，而且要使用整个单词或所有人基本都能理解的缩写，以免引起误解。是否免费3-2:如果命名使用特殊

7、规则或缩写，则必须具有备注说明。是否免费3-3:自己独特的命名风格，从头到尾都要一致，不能前后变更。是否免费3-4:对于变量命名，包含单个字符(例如I，j，k).)，除了具体的意义外，还可以表示相应的变量类型、数据类型等，但是建议将I、j、k用作局部循环变量。是否免费3-5:命名规范必须与使用的系统样式相匹配，并在同一项目中统一。例如，在UNIX上，可以将大小写混合为带下划线的样式或大小写。不要将大小写与下划线混合。是否免费4可读性4-1:注意运算符的优先级，通过用括号明确表达式的操作顺序，不使用默认优先级。是否免费4-2:避免使用难以理解的数字，用有意义的标志代替。与物理状态相关或包含物理意

8、义的常量不应直接使用数字，而应使用有意义的枚举或宏替换。是否免费5-1:删除不必要的公共变量。是否免费5-2:仔细定义和阐明公用变量的含义、职责、值范围和公用变量之间的关系。5-3:明确操作公共变量的函数或过程与公共变量的关系，例如访问、修改和创建。5-4:将数据传递到公共变量时，要非常小心，不要发生不当值或超出限制等现象。5-5:防止局部变量与公共变量同名。5-6:严禁将未初始化的变量用作右侧值。6函数，进程6-1:调用函数的错误返回代码必须慎重、全面地处理。是否免费6-2:准确(非近似值)实现函数设计的明确函数功能。是否免费6-3:编写再入函数时，必须注意局部变量的使用(例如，为C/C语言

9、编写再入函数时，必须使用auto默认局部变量或寄存器变量)。是否免费6-4:如果在编写再入函数时使用全局变量，则应使用中断、信号量(即p，v操作)等手段保护它。是否免费7可测试性7-1:在同一项目组或产品组中，必须有一组为集成测试和系统连接准备的集成测试开关及其打印函数，并具有详细说明。是否免费7-2:在同一项目组或产品组中测试和打印的信息格式必须统一。信息字符串必须至少包含模块名(或源文件名)和行号。是否免费7-3:在编程时，为单元测试选择合适的测试点，仔细编写测试代码、测试用例，并给出明确的说明。测试代码部分应作为(模块上的)子模块(通过调节开关)，以便于测试模块中的代码安装和卸载。是否免

10、费7-4:在继续进行集成测试/系统调整之前，构建测试环境、测试项目和测试案例，并仔细分析和优化测试案例以提高测试效率。是否免费7-5:使用断言发现软件问题，提高代码测试的可能性。是否免费7-6:使用断言检查程序不能正常运行，但在调节时可能出现的非法情况。是否免费7-7:最终产品确实发生，必须处理的错误情况不能通过断言确认。是否免费7-8:为更复杂的断言添加明确的解释。是否免费7-9:使用断言检查函数的参数。是否免费7-10:断言未定义的特性或功能未使用。是否免费7-11:使用断言检查程序开发环境(OS/Compiler/Hardware)中的假设。是否免费7-12:断言和其他调节代码必须从正式

11、软件产品中删除(即关闭相关调节开关)。是否免费7-13:在软件系统中设置和取消测试工具不会影响软件实现的功能等。是否免费7-14:为了减少维护困难，使用测试开关切换软件的调试版本和正式版本，而不是同时拥有正式版本和调试版本的源文件。是否免费7-15:DEBUG版本和软件发行版必须成批维护，不允许分家，应始终注意两个版本在功能上保持一致。是否免费8计划效率8-1:编程时应始终注意代码的效率。是否免费8-2:通过确保软件系统的准确性、可靠性、可读性和可测试性，提高代码效率。是否免费8-3:本地效率必须是全球效率，本地效率的提高不能影响全球效率。是否免费8-4:改进系统数据结构的分割和组织，优化程序

12、算法，提高空间效率。是否免费8-5:最小化循环中的工作量。是否免费9质量保证9-1:在软件设计过程中构建软件质量。是否免费9-2:代码质量保证优先原则是否免费9-3:仅指属于您的存储空间。是否免费9-4:防止引用已释放的内存空间。是否免费9-5:从程序/函数配置的记忆体，直到程序/函数终止为止。是否免费9-6:流程/函数申请的(用于打开文件的)文件句柄将关闭，直到流程/函数终止。是否免费9-7:确保内存活动不超过限制。是否免费9-8:仔细处理程序可能出现的各种错误情况。是否免费9-9:初始化变量和执行环境，以便系统启动时不引用未初始化的变量。是否免费9-10:在系统运行的早期对加载到系统中的数据执行一致性检查。是否免费9-11:严禁随意更改其他模块或系统的设置和配置。是否免费9-12: