C%2B%2B编码规范检查表doc

《C%2B%2B编码规范检查表doc》由会员上传分享，免费在线阅读，更多相关内容在应用文档-天天文库。

1、C++编码规范检查表密级：□保密□通用C++编码规则检查表1.0版本编写/修改日期审核日期批准日期受控编号：正文页数：附件页数：存储编号：管理部门：审查期：第6页共7页C++编码规范检查表文档修改记录日期版本修改内容修改人2003/09/05<1.0>初始版本梁勇第6页共7页C++编码规范检查表1．头文件表1头文件检查表序号检查项YESNO1[重要]---头文件使用了#ifndef/#define/#endif预处理块防范被多次引用2引用文件时，不要加绝对路径3[重要]---不要在头文件中定义变量，头文件是用来声明变量，而不是定义的。4在原文件中不要使用关键字ext

2、ern2．代码格式表2代码格式检查表序号检查项YESNO1用空行将代码按逻辑片断划分2函数间要用空行分开3函数名和左括号间不要空格4水平缩进每次4个空格5不要在单目操作符和其操作对象间加空格，如index++6不要在”::”前后加空格7在”,””;”之后（而不是之前）加空格8for语句的分号后面一个空格9每一行不要超过78个字符（78=80-2，留两个回车换行）超过78字符时，按逻辑划分成多行10处理代码中，前花括号{和后花括号}都要单独占一行，但也有例外（do语句，结构定义，类定义）。11花括号中没有或只有一条语句时也不省略花括号12每行仅放置一条语句13语句sw

3、itch中的每个case各占一行14[重要]--为所有的switch语句提供default分支处理15若某个case处理分支非空且不需要break时一定要加注释声明原因16[重要]--定义指针和引用时，*和&紧跟变量名17关于静态成员的访问使用操作符“::”，避免“.”或“->”3．注释第6页共7页C++编码规范检查表表3注释检查表序号检查项YESNO1[重要]—文件头注释：代码修改历史放在文件头的总体说明中，包括代码的作者姓名（不许用别名，呢称），修改时间以及相关的记录号（如PR/CR/DDTS号）。2[重要]--注释与编码内容相符，注意及时更新注释，注释是否有错

4、误或者可能导致误解3对每个#else或#endif给出行末注释：方便阅读者阅读，也提醒自己别配对配错了，大块的条件语句也应该做类似的处理。4不要出现无用的空循环，对必要的空循环体需要给出确认性地注释：防止阅读者误将其后紧跟的语句当成循环体。5[重要]--在函数实现之前（源文件中），要给出和实现有关的足够而精练的注释信息1．命名规则表4命名规则检查表序号检查项YESNO1[重要]--命名规则与所采用的操作系统，开发工具的风格保持一致2[重要]--程序中不应出现相同的局部变量和全局变量3类名、函数名、变量和参数、常量的命名,书写格式要遵循一定的规则2．表达式和控制流表5

5、表达式和控制流检查表序号检查项YESNO1[重要]---代码行中的运算符比较多时，用括号清楚地确定表达式的操作顺序2让表达式直观：防止编写太复杂或者多用途的复合表达式3避免在表达式中用赋值语句4不能将枚举类型进行运算后再赋值给枚举变量5避免对浮点数类型做等于或不等于判断6尝试用范围比较代替精确比较7[重要]---避免将复合表达式与“真正的数学表达式”混淆8[重要]---防止用隐含错误的方式写if语句：（1）将布尔变量直接与TRUE、FALSE或者1、0进行比较。（2）将浮点变量用“==”或“！=”与任何数字比较。（3）将指针变量用“==”或“！=”与NULL比较。第

6、6页共7页C++编码规范检查表序号检查项YESNO9[重要]---使用goto语句时是否留下隐患?例如跳过了某些对象的构造、变量的初始化、重要的计算等。10if语句中采用立即数前置的方式，如if(0==condition)方式11[重要]---防止逻辑分支出现等价支路续表5表达式和控制流检查表1．常量和宏表6常量和宏检查表序号检查项YESNO1使用含义直观的常量来表示那些将在程序中多次出现的数字或字符串2彻底地使用const常量取代宏常量定义3彻底地用inline函数替代（类似功能的）宏函数4彻底地用typedef代替宏定义新类型2．内存管理表7内存管理检查表序号检

7、查项YESNO1[重要]--new申请内存之后，立即检查指针值是否为NULL（防止使用指针值为NULL的内存）2[重要]--不要忘记为数组和动态内存赋初值（防止将未被初始化的内存作为右值使用）3[重要]--防止数组或指针的下标越界4[重要]--彻底用new,delete取代malloc,calloc,realloc和free5[重要]--New,delete和new[],delete[]要成对使用6[重要]--确保所有new出来的东西适时被delete掉7[重要]--谁申请谁释放8[重要]--当对象销亡时，确保指针成员指向的系统对内存全部被释放，防止内存泄漏9[