华为的编程规范和范例(2)

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

华为的编程规范和范例华为的编程规范和范例华为的编程规范和范例华为的编程规范和范例华为的编程规范和范例华为的编程规范和范例华为的编程规范和范例华为的编程规范和范例

/************************************************************ 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是修改历史记录列表，每条修改记录应包括修改日期、修改者及修改内容简述。

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

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

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

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

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

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

华为的编程规范和范例华为的编程规范和范例华为的编程规范和范例华为的编程规范和范例华为的编程规范和范例华为的编程规范和范例华为的编程规范和范例华为的编程规范和范例

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

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

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

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

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

¹2-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;

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

示例：

/* active statistic task number */ #define MAX_ACT_TASK_NUMBER 1000

华为的编程规范和范例华为的编程规范和范例华为的编程规范和范例华为的编程规范和范例华为的编程规范和范例华为的编程规范和范例华为的编程规范和范例华为的编程规范和范例

#define MAX_ACT_TASK_NUMBER 1000 /* active statistic task number */

¹2-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*/ };

¹2-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; ¹2-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 }

¹2-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

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

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

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

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

华为的编程规范和范 …… 此处隐藏：3191字，全部文档内容请下载后查看。喜欢就下载吧 ……