华为CC++编码规范流出.docx

一、代码排版

1、程序块要采用缩进风格编写，缩进的空格数为4个（说明：对于由开发工具自动生成的代码可以有不一致）。

2、相对独立的程序块之间、变量说明之后必须加空行。

3、循环、判断等语句中若有较长的表达式或语句，则要进行适应的划分，长表达式要在低优先级操作符处划分新行，操作符放在新行之首。

4、若函数或过程中的参数较长，则要进行适当的划分。

5、不允许把多个短语句写在一行中，即一行只写一条语句。

6、if、for、do、while、case、switch、default等语句自占一行，且if、for、do、while等语句的执行语句部分无论多少都要加括号{}。

7、对齐只使用空格键，不使用TAB键。

8、函数或过程的开始、结构的定义及循环、判断等语句中的代码都要采用缩进风格，case语句下的情况处理语句也要遵从语句缩进要求。

9、程序块的分界符（如C/C++语言的大括号‘{’和‘}’）应各独占一行并且位于同一列，同时与引用它们的语句左对齐。在函数体的开始、类的定义、结构的定义、枚举的定义以及if、for、do、while、switch、case语句中的程序都要采用如上的缩进方式。

10、在两个以上的关键字、变量、常量进行对等操作时，它们之间的操作符之前、之后或者前后要加空格；进行非对等操作时，如果是关系密切的立即操作符（如-），后不应加空格（说明：采用这种松散方式编写代码的目的是使代码更加清晰）。

注意：

（1）由于留空格所产生的清晰性是相对的，所以,在已经非常清晰的语句中没有必要再留空格，如果语句已足够清晰则括号内侧（即左括号后面和右括号前面）不需要加空格，多重括号间不必加空格，因为在C/C++语言中括号已经是最清晰的标志了。

（2）在长语句中，如果需要加的空格非常多，那么应该保持整体清晰，而在局部不加空格。给操作符留空格时，不要连续留两个以上空格。

二、代码注释

1、一般情况下，源程序有效注释量必须在20％以上（说明：注释的原则是有助于对程序的阅读理解，在该加的地方都加了，注释不宜太多也不能太少，注释语言必须准确、易懂、简洁）。

2、说明性文件（如头文件.h文件、.inc文件、.def文件、编译说明文件.cfg等）头部应进行注释，注释必须列出：版权说明、版本号、生成日期、作者、内容、功能、与其它文件的关系、修改日志等，头文件的注释中还应有函数功能简要说明。

3、源文件头部应进行注释，列出：版权说明、版本号、生成日期、作者、模块目的/功能、主要函数及其功能、修改日志等。

4、函数头部应进行注释，列出：函数的目的/功能、输入参数、输出参数、返回值、调用关系（函数、表）等。

示例：

下面这段函数的注释比较标准，当然，并不局限于此格式，但上述信息建议要包含在内。

?Function://函数名称

?Description://函数功能、性能等的描述

?Calls://被本函数调用的函数清单

?CalledBy://调用本函数的函数清单

?TableAccessed://被访问的表（此项仅对于牵扯到数据库操作的程序）

?TableUpdated://被修改的表（此项仅对于牵扯到数据库操作的程序）

?Input://输入参数说明，包括每个参数的作用、取值说明及参数间关系

?Output://对输出参数的说明

?Return://函数返回值的说明

5、边写代码边注释，修改代码同时修改相应的注释，以保证注释与代码的一致性；不再有用的注释要删除。

6、注释的内容要清楚、明了，含义准确，防止注释二义性。

7、避免在注释中使用缩写，特别是非常用缩写。

8、注释应与其描述的代码相近，对代码的注释应放在其上方或右方（对单条语句的注释）相邻位置，不可放在下面，如放于上方则需与其上面的代码用空行隔开。

9、对于所有有物理含义的变量、常量，如果其命名不是充分自注释的，在声明时都必须加以注释，说明其物理含义。变量、常量、宏的注释应放在其上方相邻位置或右方。

10、数组、结构、类、枚举等，如果其命名不是充分自注释的，必须加以注释。对数据结构的注释应放在其上方相邻位置，不可放在下面；对结构中的每个域的注释放在此域的右方。

11、全局变量要有较详细的注释，包括对其功能、取值范围、哪些函数或过程存取它以及存取时注意事项等的说明。

12、注释与所描述内容进行同样的缩排。

13、将注释与其上面的代码用空行隔开。

14、函数的头部应进行注释，列出函数的功能、目的、输入输出参数、返回值、调用关系（表、函数）等。

15、对变量的定义和分支语句（条件分支、循环语句等）必须编写注释。

16、对于switch语句下的case语句，如果因为特殊情况需要处理完一个case后进入下一个case处理，必须在该case语句处理