C++程序书写规范.docVIP

C++程序书写规范 万 健 2009/8/8 目录 一. 前言 2 二. C++程序书写规范 3 1. 头文件 3 2. 语句 3 3. 程序注释 3 4. 缩进 4 5. 程序块 4 6. 空行 5 7. 空格 6 8. 圆括弧 6 9. 浮点常量 7 10. 对齐 7 11. 类的声明 8 12. 指针和引用变量 9 三. 标识符命名规则 10 1. 符号常量 11 2. 类，常数，结构，枚举和类型名 11 3. 变量名，参数名，缩略语 11 4. 函数名 11 5. 匈牙利命名法 12 四. C/C++代码格式化工具 13 1. SourceFormatX 13 2. Astyle 13 五. 参考文献 14  前言 在商品化软件开发中，非常重视程序编码规范，不同的公司或组织有不同规范，比如：“GNU Coding Standards”、“Google C++ Style Guide”等。 C++程序编码规范（C++ Coding Standard）包含以下两个含义： C++程序设计规范 C++程序书写规范 程序设计规范牵涉程序开发过程中可靠性、可维护性、安全性的话题，而程序书写规范是程序员约定的通行书写格式。本文主要讨论的是C++的程序书写格式。现在计算机专业教学过程中不重视程序书写格式规范化教学，一些教材中的程序书写格式五花八门，造成学生在大学四年中缺乏规范化的编码训练，直接影响学生毕业求职与工作。 C++的程序书写规范最初缘自KD的《C Programming Language》一书以及Unix早期的源代码，一般称为“KD的风格”，最典型的特征是函数参数声明、带下划线的标识符和花括号的位置，早期的程序缩 int sample_function() int x, y; /* x和y为函数的形式参数 */ { …… if (……) { ……; ……; } …… } 随着C语言的发展，特别是C++的出现，特别是微软公司的Windows程序设计的影响，程序设计风格发生的一系列的变化，出现的GNU、Linux、VC等规范，也出现标识符的匈牙利命名法等规范，主要还是分为Unix/Linux和Windows两大流派，Java的风格偏向于Unix/Linux。 本文主要是综合网络上发布的资料，根据程序开发的通行做法，约定了C++程序的书写规范。 C++程序书写规范 头文件 头文件必须包含#ifndef…#endif结构。 #ifndef COM_COMPANY_MODULE_CLASSNAME_H #define COM_COMPANY_MODULE_CLASSNAME_H : #endif // COM_COMPANY_MODULE_CLASSNAME_H 参见： 文献[1]第40条 语句 一条语句占一行或多行，避免一行写多条语句，除非这些语句非常相关。 参见： 文献[2]“One Statement Per Line”章节 程序注释 程序注释包含段注释和行注释两种，段注释单独一行或几行，主要说明下面一段程序完成什么功能，行注释用于解释某条语句的功能。注意注释书写的对齐。 // 该函数完成的功能 void SampleFunction() { // 段注释1 …… // 行注释1 …… // 行注释2 …… // 段注释2 …… if (……) { // 段注释3 // …… } } 缩进 程序块缩进大小为2到4个空格之间，通常为4个空格。不用采用TAB控制符，而是采用空格符。如在Visual Studio2005中选择“工具-选项-文本编辑器-C/C++-制表符-插入空格”、在DEV C++中的“Editor Options”取消“Use Tab Character”。 参见： 文献[1]第38条 文献[2]“Indentation/Tabs/Space Policy”章节 文献4“Spaces vs. Tabs”章节 程序块 程序块的花括号位置有三种写法，推荐采用第一或第二种格式 // 现代C/C++写法 while (!done) { doSomething(); done = moreToDo(); } // 传统C/C++写法 while (!done) { doSomething(); done = moreToDo(); } // GNU写法 while (!done) { doSomething(); done = moreToD