C++代码评审检查表

 

类别

检查项

符合 (/)

备注

命名规范

函数、变量、文件名具有描述性,少用缩写

 

 

文件名全部小写,使用 _  -

 

 

类型名称采用首字母大写的驼峰式

 

 

变量(含函数参数)和数据成员名使用小写 + 下划线

 

 

类成员变量以下划线结尾,但结构体成员变量不加下划线

 

 

变量或常量以 k开头,大小写混合

 

 

 

常规函数使用驼峰式

 

 

命名空间使用小写字母

 

 

 

宏定义全大写 + 下划线

 

 

格式规范

仅使用空格缩进(2 个空格),无制表符(Tab

 

 

 

函数返回类型和函数名在同一行,参数尽量同行,分行方式与调用一致

 

 

每行代码不超过 80 字符

 

 

 

句点 、箭头前后无空格,指针和引用后无空格

 

 

 

预处理指令不缩进,从行首开始

 

 

注释规范

使用///**/注释

 

 

每个类定义有注释说明功能和用法

 

 

 

函数声明处注释描述功能,定义处注释描述实现细节

 

 

 

变量名足够清晰

 

其他检查

符合项目的其他特定规范

 

 

 

无明显的性能问题

 

 

 

错误处理恰当(如异常捕获、返回值检查)

 

 

 

无未使用的代码或变量

 

posted @ 2025-03-03 09:01  涨涨涨张  阅读(28)  评论(0)    收藏  举报