软件编程规范
应该按照以下的格式书写： void foo() {
?// program code
}
if (i == 0) {
?// program code
}
foo->bar, foo.bar, foo[bar]
i++, !i, &i
i += 9, a *b
11
第二章 注释
规则2-1：源文件头部应进行注释，列出：生成日期、作者、模块目的/功能等。
示例：下面这段源文件的头注释比较标准，当然，并不局限于此格式，但上述信息建议要包含在内。
/************************************************************ FileName: test.cpp
Author: Version : Date: Description: // 模块描述 Version: // 版本信息
Function List: // 主要函数及其功能 1. -------
History: // 历史修改记录
David 96/10/12 1.0 build this moudle
***********************************************************/ 说明：Description一项描述本文件的内容、功能、内部各部分之间的关系及本文件与其它文件关系等。History是修改历史记录列表，每条修改记录应包括修改日期、修改者及修改内容简述。
也可以采用javadoc 风格的文档注释，这里不再举例，下同。
规则2-2：函数头部应进行注释，列出：函数的目的/功能、输入参数、输出参数、返回值等。 示例：下面这段函数的注释比较标准，当然，并不局限于此格式，但上述信息建议要包含在内。
/************************************************* Function: // 函数名称
Description: // 函数功能、性能等的描述 Calls: // 被本函数调用的函数清单 Called By: // 调用本函数的函数清单
Table Accessed: // 被访问的表（此项仅对于牵扯到数据库操作的程序）
12
Table Updated: // 被修改的表（此项仅对于牵扯到数据库操作的程序） Input: // 输入参数说明，包括每个参数的作 // 用、取值说明及参数间关系。 Output: // 对输出参数的说明。 Return: // 函数返回值的说明 Others: // 其它说明
*************************************************/
规则2-3：注释应该和代码同时更新，不再有用的注释要删除。
规则2-4：注释的内容要清楚、明了，不能有二义性。 说明：错误的注释不但无益反而有害。
建议2-1：避免在注释中使用非常用的缩写或者术语。
规则2-5：注释的版式
说明：注释也需要与代码一样整齐排版
1. 注释应与其描述的代码相近，对代码的注释应放在其上方或右方（对单条语句的注释）相邻位置，不可放在下面，如放于上方则需与其上面的代码用空行隔开。 2. 注释与所描述内容进行同样的缩排 3. 将注释与其上面的代码用空行隔开
4. 变量、常量、宏的注释应放在其上方相邻位置或右方
示例：如下例子不符合规范。
例1：注释在代码行之下
repssn_ind = ssn_data[index].repssn_index; repssn_ni = ssn_data[index].ni;
/* get replicate sub system index and net indicator */
13
例2：缩进不统一
void example_fun( void ) {
/* code one comments */ CodeBlock One
/* code two comments */ CodeBlock Two }
例3：代码过于紧凑
/* code one comments */ program code one
/* code two comments */ program code two
规则2-6：对于所有有物理含义的变量、常量，如果其命名不是充分自注释的，在声明时都必须加以注释，说明其物理含义。 示例：以下都是允许的注释方式
/* active statistic task number */ #define MAX_ACT_TASK_NUMBER 1000
#define MAX_ACT_TASK_NUMBER 1000 /* active statistic task number */
规则2-7：数据结构声明(包括数组、结构、类、枚举等)，如果其命名不是充分自注释的，必须加以注释。对数据结构的注释应放在其上方相邻位置，不可放在下面；对结构中的每个域的注释可放在此域的右方。
示例：可按如下形式说明枚举/数据/联合结构。
/* sccp interface with sccp user primitive message name */ enum SCCP_USER_PRIMITIVE {
N_UNITDATA_IND, /* sccp notify sccp user unit data come */ N_NOTICE_IND, /* sccp notify user the No.7 network can not */
14
/* transmission this message */
N_UNITDATA_REQ, /* sccp user's unit data transmission request*/ };
建议2-2：对重要变量的定义需编写注释，特别是全局变量，更应有较详细的注释，包括对其功能、取值范围、哪些函数或过程存取它以及存取时注意事项等的说明。
示例：
/* The ErrorCode when SCCP translate */
/* Global Title failure, as follows */ // 变量作用、含义 /* 0 － SUCCESS 1 － GT Table error */
/* 2 － GT error Others － no use */ // 变量取值范围 /* only function SCCPTranslate() in */ /* this modual can modify it, and other */ /* module can visit it through call */
/* the function GetGTTransErrorCode() */ // 使用方法 BYTE g_GTTranErrorCode;
建议2-3：分支语句（条件分支、循环语句等）需编写注释。
说明：这些语句往往是程序实现某一特定功能的关键，对于维护人员来说，良好的注释帮助更好的理解程序，有时甚至优于看设计文档。
规则2-8：注释不宜过多，也不能太少，源程序中有效注释量控制在20％~30%之间。 说明：注释是对代码的“提示”，而不是文档，不可喧宾夺主，注释太多会让人眼花缭乱。
15