华为软件编程规范学习(二)--注释

华为软件编程规范学习(二)--注释

转自：http://blog.csdn.net/ce123_zhouwei/article/details/8885964

2-1：一般情况下，源程序有效注释量必须在20％以上

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

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

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

[plain]  view plain  copy

1. /*************************************************  
2.   Copyright (C),1988-1999, Huawei Tech. Co., Ltd.  
3.   Filename:      // 文件名  
4.   Author:      Version:        Date: // 作者、版本及完成日期  
5.   Description:    // 用于详细说明此程序文件完成的主要功能，与其他模块  
6.                  // 或函数的接口，输出值、取值范围、含义及参数间的控  
7.                  // 制、顺序、独立或依赖等关系  
8.   Others:         // 其它内容的说明  
9.   FunctionList:  // 主要函数列表，每条记录应包括函数名及功能简要说明  
10.     1.....  
11.   History:        // 修改历史记录列表，每条修改记录应包括修改日期、修改  
12.                  // 作者及修改内容简述   
13.     1.Date:  
14.       Author:  
15.       Modification:  
16.     2....  
17. *************************************************/  

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

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

[plain]  view plain  copy

1. /************************************************************  
2.   Copyright (C),1988-1999, Huawei Tech. Co., Ltd.  
3.   FileName:test.cpp  
4.   Author:        Version:          Date:  
5.   Description:     // 模块描述       
6.   Version:         // 版本信息  
7.   FunctionList:   // 主要函数及其功能  
8.     1.-------  
9.   History:         // 历史修改记录  
10.      <author>  <time>   <version >  <desc>  
11.      David    96/10/12    1.0     build this moudle   
12. ***********************************************************/  

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

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

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

[plain]  view plain  copy

1. /*************************************************  
2.  Function:       // 函数名称  
3.  Description:    // 函数功能、性能等的描述  
4.  Calls:          // 被本函数调用的函数清单  
5.  CalledBy:      // 调用本函数的函数清单  
6.  TableAccessed: // 被访问的表（此项仅对于牵扯到数据库操作的程序）  
7.  TableUpdated:  // 被修改的表（此项仅对于牵扯到数据库操作的程序）  
8.  Input:          // 输入参数说明，包括每个参数的作  
9.                  // 用、取值说明及参数间关系。  
10.  Output:         // 对输出参数的说明。  
11.  Return:         // 函数返回值的说明  
12.  Others:         // 其它说明  
13. *************************************************/  

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

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

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

2-7：避免在注释中使用缩写，特别是非常用缩写

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

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

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

[plain]  view plain  copy

1. repssn_ind = ssn_data[index].repssn_index;  
2. repssn_ni = ssn_data[index].ni;  
3. /* get replicate subsystem index and net indicator */  

应如下书写

[plain]  view plain  copy

1. /* get replicate subsystem index and net indicator */  
2. repssn_ind =ssn_data[index].repssn_index;  
3. repssn_ni =ssn_data[index].ni;  

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

示例：

[plain]  view plain  copy

1. /* active statistictask number */  
2. #defineMAX_ACT_TASK_NUMBER 1000  
3. #defineMAX_ACT_TASK_NUMBER 1000 /* active statistic task number */  

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

示例：可按如下形式说明枚举/数据/联合结构。

[plain]  view plain  copy

1. /* sccp interfacewith sccp user primitive message name */  
2. enum  SCCP_USER_PRIMITIVE  
3. {  
4.    N_UNITDATA_IND, /* sccp notify sccp user unit data come */  
5.    N_NOTICE_IND,   /* sccp notify user the No.7 network can not */  
6.                    /* transmission this message */  
7.    N_UNITDATA_REQ, /* sccp user's unit data transmission request*/  
8. };  

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

示例：

[plain]  view plain  copy

1. /* The ErrorCode whenSCCP translate */  
2. /* Global Titlefailure, as follows */      // 变量作用、含义  
3. /* 0 － SUCCESS   1 － GT Table error */  
4. /* 2 － GT error  Others － no use */       // 变量取值范围  
5. /* only  function SCCPTranslate() in */  
6. /* this modual canmodify it,  and  other */  
7. /* module can visitit through call */  
8. /* the  functionGetGTTransErrorCode() */    // 使用方法  
9. BYTE g_GTTranErrorCode;   

2-12：注释与所描述内容进行同样的缩排

说明：可使程序排版整齐，并方便注释的阅读与理解。

示例：如下例子，排版不整齐，阅读稍感不方便。

[plain]  view plain  copy

1. void example_fun(void )  
2. {  
3. /* code one comments*/  
4.    CodeBlock One  
5.    
6.        /* code two comments */  
7.    CodeBlock Two  
8. }  

应改为如下布局。

[plain]  view plain  copy

1. void example_fun(void )  
2. {  
3.     /*code one comments */  
4.    CodeBlock One  
5.     /*code two comments */  
6.    CodeBlock Two  
7. }  

2-13：将注释与其上面的代码用空行隔开

示例：如下例子，显得代码过于紧凑。

[plain]  view plain  copy

1. /* code one comments*/  
2. program code one  
3. /* code two comments*/  
4. program code two  

应如下书写

[plain]  view plain  copy

1. /* code one comments*/  
2. program code one  
3.   
4. /* code two comments*/  
5. program code two  

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

说明：这些语句往往是程序实现某一特定功能的关键，对于维护人员来说，良好的注释帮助更好的理解程序，有时甚至优于看设计文档。

2-15：对于switch语句下的case语句，如果因为特殊情况需要处理完一个case后进入下一个case处理，必须在该case语句处理完、下一个case语句前加上明确的注释

说明：这样比较清楚程序编写者的意图，有效防止无故遗漏break语句。

示例（注意斜体加粗部分）：

[plain]  view plain  copy

1. caseCMD_UP:    
2.    ProcessUp();  
3.    break;  
4. case CMD_DOWN:  
5.     ProcessDown();  
6.    break;  
7. case CMD_FWD:   
8.    ProcessFwd();  
9.    if (...)  
10.    {  
11.         ...  
12.         break;  
13.    }  
14.    else  
15.    {  
16.        ProcessCFW_B();   // now jump into case CMD_A  
17.    }  
18. caseCMD_A:     
19.    ProcessA();     
20.    break;  
21. caseCMD_B:     
22.    ProcessB();     
23.    break;  
24. case CMD_C:     
25.    ProcessC();     
26.     break;  
27. caseCMD_D:     
28.    ProcessD();     
29.    break;  
30. ...  

其他

2-1：避免在一行代码或表达式的中间插入注释

说明：除非必要，不应在代码或表达中间插入注释，否则容易使代码可理解性变差。

2-2：通过对函数或过程、变量、结构等正确的命名以及合理地组织代码的结构，使代码成为自注释的

说明：清晰准确的函数、变量等的命名，可增加代码可读性，并减少不必要的注释。

2-3：在代码的功能、意图层次上进行注释，提供有用、额外的信息

说明：注释的目的是解释代码的目的、功能和采用的方法，提供代码以外的信息，帮助读者理解代码，防止没必要的重复注释信息。

示例：如下注释意义不大。

[plain]  view plain  copy

1. /* if receive_flag isTRUE */  
2. if (receive_flag)  

而如下的注释则给出了额外有用的信息。

[plain]  view plain  copy

1. /* if mtp receive amessage from links */  
2. if (receive_flag)  

2-4：在程序块的结束行右方加注释标记，以表明某程序块的结束

说明：当代码段较长，特别是多重嵌套时，这样做可以使代码更清晰，更便于阅读。

示例：参见如下例子。

[plain]  view plain  copy

1. if (...)  
2. {  
3.    //program code  
4.    while (index < MAX_INDEX)  
5.     {  
6.        // program code  
7.     }/* end of while (index < MAX_INDEX) */ // 指明该条while语句结束  
8. } /* end of  if(...)*/ // 指明是哪条if语句结束  

2-5：注释格式尽量统一，建议使用“/* …… */”

2-6：注释应考虑程序易读及外观排版的因素，使用的语言若是中、英兼有的，建议多使用中文，除非能用非常流利准确的英文表达

说明：注释语言不统一，影响程序易读性和外观排版，出于对维护人员的考虑，建议使用中文。