天融信DLP部门 C/C++编码规范.docx

天融信DLP部门 C/C++编码规范 本篇文章旨在总结和系统化C/C++部门编码规范，涵盖命名规范、注释、bug规避等方面，以便于开发者遵循一致的编码标准，提高代码质量和可维护性。 一、命名规范 1.1 通用命名规则：函数命名、变量命名、文件命名应具有描述性，不要过度缩写。类型和变量应是“[形容词] + 名词”，函数的命名应是“动词 + [名词]”。 1.2 源文件命名：文件名要全部小写，可以包含下划线（_），并按项目模块来命名。 1.3 类型命名：类型命名每个单词以大写字母开头，不包含下划线。 1.4 变量命名：变量名一律小写，单词间以下划线相连，全局变量以“g_”开头。 1.5 常量命名：所有编译时常量，全部大写、使用下划线。 1.6 函数命名：函数名以大写字母开头，每个单词首字母大写，没有下划线。 1.7 命名空间命名：命名空间的名称是全小写的，其命名基于项目名称和目录结构。 1.8 枚举命名：枚举名按“1.3 类型命名”命名。枚举值应全部大写，单词间以下划线相连。 1.9 宏命名：通常是不使用宏的，如果绝对要用，其命名像枚举命名一样全部大写、使用下划线。 1.10 函数参数命名：函数参数名前用“_”下划线开头【可选】，其他遵循“1.4 变量命名”约定。 1.11 函数参数次序：输入参数在前，输出参数在后，既是入参又是出参按出参处理。 1.12 函数参数的合法性检查：规定由接口函数本身负责，对接口函数调用者透明，避免两者均对其进行检查，减少冗余代码，提高效率。 1.13 函数调用格式：多个实参间的添加 1 个空格，且空格在逗号的右边（逗号靠近左边的参数）。 1.14 包含文件次序：次序如下：C 库、C++库、其他库的.h、项目内的.h。 1.15 类中声明次序：在类中使用特定的声明次序：public:在 private:之前，成员函数在数据成员前。 本篇文章提供了一份完整的C/C++部门编码规范，旨在提高代码质量和可维护性，减少bug和冗余代码，提高开发效率。