代码规范

同一列，同时与引用它们的语句左对齐。在函数体的开始、类的定义、结构的定义、枚举的定义以及if、for、do、while、switch、case语句中的程序都要采用如上的缩进方式。

示例：如下例子不符合规范。 for (...) {

... // program code }

if (...) {

... // program code }

void example_fun( void ) {

... // program code }

应如下书写。 for (...) {

... // program code }

if (...) {

... // program code }

void example_fun( void ) {

... // program code }

11. 在两个以上的关键字、变量、常量进行对等操作时，它们之间的操作符之前、

之后或者前后要加空格；进行非对等操作时，如果是关系密切的立即操作符（如－>），后不应加空格。

说明：采用这种松散方式编写代码的目的是使代码更加清晰。

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

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

示例：

(1) 逗号、分号只在后面加空格。 int a, b, c;

(2)比较操作符, 赋值操作符\、 \，算术操作符\、\，逻辑操作符\、\，位域操作符\、\等双目操作符的前后加空格。

if (current_time >= MAX_TIME_VALUE) a = b + c; a *= 2; a = b ^ 2;

(3)\、\、\、\、\（地址运算符）等单目操作符前后不加空格。 *p = 'a'; // 内容操作\与内容之间 flag = !isEmpty; // 非操作\与内容之间 p = &mem; // 地址操作\与内容之间 i++; // \与内容之间

(4)\、\前后不加空格。

p->id = pid; // \指针前后不加空格

(5) if、for、while、switch等与后面的括号间应加空格，使if等关键字更为突出、明显。

if (a >= b && c > d)

12. 一行程序以小于80字符为宜，不要写得过长。

3. 注释

1. 一般情况下，源程序有效注释量必须在40％以上。

说明：注释的原则是有助于对程序的阅读理解，在该加的地方都加了，注释不宜太多也不能太少，注释语言必须准确、易懂、简洁。

2. 源文件头部应进行注释，列出：版权说明、版本号、生成日期、作者、模块目

的/功能、主要函数及其功能、修改日志等。

示例：下面这段源文件的头注释比较标准，当然，并不局限于此格式，但上述信息建议要包含在内。

/**************************************************** Copyright (C), 1988-1999, Huawei Tech. Co., Ltd. FileName: test.cpp

Author: Version : Date: Description: // 模块描述 Version: // 版本信息

Function List: // 主要函数及其功能 1. -------

History: // 历史修改记录

David 96/10/12 1.0 build this moudle ******************************************************/

说明：Description一项描述本文件的内容、功能、内部各部分之间的关系及本文件与其它文件关系等。History是修改历史记录列表，每条修改记录应包括修改日期、修改者及修改内容简述。

3. 函数头部应进行注释，列出：函数的目的/功能、输入参数、输出参数、返回值、

调用关系（函数、表）等。

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

/************************************************* Function: // 函数名称

Description: // 函数功能、性能等的描述 Calls: // 被本函数调用的函数清单 Called By: // 调用本函数的函数清单

Table Accessed: // 被访问的表（此项仅对于牵扯到数据库操作的程序） Table Updated: // 被修改的表（此项仅对于牵扯到数据库操作的程序） Input: // 输入参数说明，包括每个参数的作 // 用、取值说明及参数间关系。 Output: // 对输出参数的说明。 Return: // 函数返回值的说明 Others: // 其它说明

*************************************************/

4. 边写代码边注释，修改代码同时修改相应的注释，以保证注释与代码的一致性。

不再有用的注释要删除。

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

说明：错误的注释不但无益反而有害。

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

说明：在使用缩写时或之前，应对缩写进行必要的说明。

7. 注释应与其描述的代码相近，对代码的注释应放在其上方或右方（对单条语句

的注释）相邻位置，不可放在下面，如放于上方则需与其上面的代码用空行隔开。

示例：如下例子不符合规范。 例1：

/* get replicate sub system index and net indicator */