SN_IP04编码规范与范例_C++规范V1.2分析报告.doc

PC客户端项目组 C++ 编程标准——命名和风格 我们采用微软.Net Framework命名规范，和MicroSoft保持一致，便于融合使用微软的最佳实践，也便于阅读。实际上这涉及到两种命名规则：Pascal命名规则和Camel命名规则，他们出现的场景不同。这两种规范都要求变量命名时少用缩略词和无意义的字母，变量名称能够概括代表的功能，可以由多个词连续排列构成，每个单词之间称为逻辑断点。  Pascal规范：变量名称能够概括功能，由单词不间断组合在一起，每个单词的首字母都大写，如：MyClass  Camel规范：变量名称能够概括功能，由单词不间断组合在一起，变量首字母小写，其它的每个单词都大写，如：myClass  匈牙利命名规则：十分必要的情况下，在变量前加上数据类型前缀，尽量不要使用匈牙利命名规则，因为晦涩难懂。 我们采用Resharper作为规范检查工具  目录 PC客户端项目组 1 C++ 编程标准——命名和风格 1 1 命名规则 4 1.1 总则 4 1.2 类/结构 5 1.3 函数 5 1.4 变量 6 1.5 常量 7 1.6 枚举、联合、typedef 7 1.7 宏、枚举值 8 2 文件结构 8 2.1 文件头注释 8 2.2 头文件 9 2.3 实现文件 10 3 代码风格与版式 11 3.1 语句与代码行 12 3.2 缩进和对齐 12 3.3 最大长度 13 3.4 长行拆分 13 3.5 空格的使用 14 3.6 修饰符的位置 16 3.7 注释 16 4 注释分类说明 17 4.1 源文件头部注释 17 4.2 函数头部注释 17 4.3 全局变量的注释 18 附：QT控件命名规范 20 特别说明： 21  1 命名规则 1.1 总则 在软件开发这一高度抽象而且十分复杂的活动中，命名规则的重要性更显得尤为突出。一套定义良好并且完整的、在整个项目中统一使用的命名规范将大大提升源代码的可读性和软件的可维护性。 在引入细节之前，先说明一下命名规范的整体原则： 同一性 在编写一个子模块或派生类的时候，要遵循其基类或整体模块的命名风格，保持命名风格在整个模块中的同一性。 标识符组成 标识符采用英文单词或其组合，应当直观且可以拼读，可望文知意，用词应当准确。 最小化长度 最大化信息量原则 在保持一个标识符意思明确的同时，应当尽量缩短其长度。 避免过于相似 不要出现仅靠大小写区分的相似的标识符，例如“i”与“I”，“function”与“Function”等等。 避免在不同级别的作用域中重名 程序中不要出现名字完全相同的局部变量和全局变量，尽管两者的作用域不同而不会发生语法错误，但容易使人误解。 正确命名具有互斥意义的标识符 用正确的反义词组命名具有互斥意义的标识符，如：nMinValue和nMaxValue，GetName() 和 SetName() .... 避免名字中出现数字编号 尽量避免名字中出现数字编号，如Value1,Value2等，除非逻辑上的确需要编号。这是为了防止程序员偷懒，不肯为命名动脑筋而导致产生无意义的名字（因为用数字编号最省事）。 1.2 类/结构 除了异常类等个别情况（不希望用户把该类看作一个普通的、正常的类之情况）外，C++类/结构的命名应该遵循以下准则： C++类/结构的命名 类的名称按实际情况，每个单词的首字母大写，保持文件名与类名一致。 推荐的组成形式 类的命名推荐用名词或形容词＋名词的形式，例如：CAnalyzer, CFastVector .... 不同于C++类的概念，传统的C结构体只是一种将一组数据捆绑在一起的方式。传统C结构体的命名规则为： 传统C结构体的命名 传统C结构体的名称全部由大写字母组成，单词间使用下划线界定，例如：SERVICE_STATUS_S, DRIVER_INFO .... 1.3 函数 函数的命名 函数的名称由一个或多个单词组成。为便于界定，每个单词的首字母要大写。 推荐的组成形式 函数名应当使用动词或者动词＋名词（动宾词组）的形式。例如：GetName(), SetValue(), Erase(), Reserve() .... 保护成员函数 保护成员函数的开头应当加上一个下划线“_”以示区别，例如：_SetState() .... 私有成员函数 类似地，私有成员函数的开头建议加上两个下划线“__”，例如：__DestroyImp() ....不强制。 虚函数 虚函数习惯以“Do”开头，如：DoRefresh(), _DoEncryption() .... 回调和事件处理函数 回调和事件处理函数习惯以单词“On”开头。例如：OnTimer(), OnExit() .... 1.4 变量 变量应该是程序中使用最多的标识符了，变