************/
12-3：源文件头部应进行注释，列出：版权说明、版本号、生成日期、作者、模块目的/功能、
主要函数及其功能、修改日志等。
示例：下面这段源文件的头注释比较标准，当然，并不局限于此格式，但上述信息建议要
包含在内。
/************************************************************
copyright (c), 1988-1999, huawei tech. co., ltd.
filename: test.cpp
author: version : date:
description: // 模块描述
version: // 版本信息
function list: // 主要函数及其功能
1. -------
history: // 历史修改记录
<author> <time> <version > <desc>
david 96/10/12 1.0 build this moudle
***********************************************************/
说明：description一项描述本文件的内容、功能、内部各部分之间的关系及本文件与
其它文件关系等。history是修改历史记录列表，每条修改记录应包括修改日期、修改
者及修改内容简述。
12-4：函数头部应进行注释，列出：函数的目的/功能、输入参数、输出参数、返回值、调用
关系（函数、表）等。
示例：下面这段函数的注释比较标准，当然，并不局限于此格式，但上述信息建议要包含
在内。
/*************************************************
function: // 函数名称
description: // 函数功能、性能等的描述
calls: // 被本函数调用的函数清单
called by: // 调用本函数的函数清单
table accessed: // 被访问的表（此项仅对于牵扯到数据库操作的程序）
table updated: // 被修改的表（此项仅对于牵扯到数据库操作的程序）
input: // 输入参数说明，包括每个参数的作
// 用、取值说明及参数间关系。
output: // 对输出参数的说明。
return: // 函数返回值的说明
others: // 其它说明
*************************************************/
12-5：边写代码边注释，修改代码同时修改相应的注释，以保证注释与代码的一致性。不再有
用的注释要删除。
12-6：注释的内容要清楚、明了，含义准确，防止注释二义性。
说明：错误的注释不但无益反而有害。
规则2-7：避免在注释中使用缩写，特别是非常用缩写。
说明：在使用缩写时或之前，应对缩写进行必要的说明。
12-8：注释应与其描述的代码相近，对代码的注释应放在其上方或右方（对单条语句的注释）
相邻位置，不可放在下面，如放于上方则需与其上面的代码用空行隔开。
示例：如下例子不符合规范。
例1：
/* get replicate sub system index and net indicator */
repssn_ind = ssn_data[index].repssn_index;
repssn_ni = ssn_data[index].ni;
例2：
repssn_ind = ssn_data[index].repssn_index;
repssn_ni = ssn_data[index].ni;
/* get replicate sub system index and net indicator */
应如下书写
/* get replicate sub system index and net indicator */
repssn_ind = ssn_data[index].repssn_index;
repssn_ni = ssn_data[index].ni;
12-9：对于所有有物理含义的变量、常量，如果其命名不是充分自注释的，在声明时都必须加
以注释，说明其物理含义。变量、常量、宏的注释应放在其上方相邻位置或右方。
示例：
/* active statistic task number */
#define max_act_task_number 1000
#define max_act_task_number 1000 /* active statistic task number */
12-10：数据结构声明(包括数组、结构、类、枚举等)，如果其命名不是充分自注释的，必须
加以注释。对数据结构的注释应放在其上方相邻位置，不可放在下面；对结构中的每个域的注
释放在此域的右方。
示例：可按如下形式说明枚举/数据/联合结构。
/* 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 */
/* transmission this message */
n_unitdata_req, /* sccp user's unit data transmission request*/
};
12-11：全局变量要有较详细的注释，包括对其功能、取值范围、哪些函数或过程存取它以及
存取时注意事项等的说明。
示例：
/* 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;
12-12：注释与所描述内容进行同样的缩排。
说明：可使程序排版整齐，并方便注释的阅读与理解。
示例：如下例子，排版不整齐，阅读稍感不方便。
void example_fun( void )
{
/* code one comments */
codeblock one
/* code two comments */
codeblock two
}
应改为如下布局。
void example_fun( void )
{
/* code one comments */
codeblock one
/* code two comments */
codeblock two
}
12-13：将注释与其上面的代码用空行隔开。
示例：如下例子，显得代码过于紧凑。
/* code one comments */
program code one
/* code two comments */
program code two
应如下书写
/* code one comments */
program code one
/* code two comments */
program code two
12-14：对变量的定义和分支语句（条件分支、循环语句等）必须编写注释。
说明：这些语句往往是程序实现某一特定功能的关键，对于维护人员来说，良好的注释帮
助更好的理解程序，有时甚至优于看设计文档。
12-15：对于switch语句下的case语句，如果因为特殊情况需要处理完一个case后进入下一
个case处理，必须在该case语句处理完、下一个case语句前加上明确的注释。
说明：这样比较清楚程序编写者的意图，有效防止无故遗漏break语句。
示例（注意斜体加粗部分）：
case cmd_up:
processup();
break;
case cmd_down:
processdown();
break;
case cmd_fwd:
processfwd();
if (...)
{
...
break;
}
else
{
processcfw_b(); // now jump into case cmd_a
}
case cmd_a:
processa();
break;
case cmd_b:
processb();
break;
case cmd_c:
processc();
break;
case cmd_d:
processd();
break;
...
.2-1：避免在一行代码或表达式的中间插入注释。
说明：除非必要，不应在代码或表达中间插入注释，否则容易使代码可理解性变差。
.2-2：通过对函数或过程、变量、结构等正确的命名以及合理地组织代码的结构，使代码成为
自注释的。
说明：清晰准确的函数、变量等的命名，可增加代码可读性，并减少不必要的注释。
.2-3：在代码的功能、意图层次上进行注释，提供有用、额外的信息。
说明：注释的目的是解释代码的目的、功能和采用的方法，提供代码以外的信息，帮助读
者理解代码，防止没必要的重复注释信息。
示例：如下注释意义不大。
/* if receive_flag is true */
if (receive_flag)
而如下的注释则给出了额外有用的信息。
/* if mtp receive a mes