内容发布更新时间 : 2024/5/13 8:46:45星期一 下面是文章的全部内容请认真阅读。

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)

?1-1：一行程序以小于80字符为宜，不要写得过长。

〔二〕 ======[ 注释 ]=======

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

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

12-2 ：说明性文件（如头文件.h 文件、.inc 文件、.def 文件、编译说明文件.cfg 等）头部应进行注释，注释必须列出：版权说明、版本号、生成日期、

作者、内容、功能、与其它文件的关系、修改日志等，头文件的注释中还应有函数功能简要说明

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

/************************************************* Copyright (C), 1988-1999, Huawei Tech. Co., Ltd. File name: // 文件名

Author: Version: Date: // 作者、版本及完成日期

Description: // 用于详细说明此程序文件完成的主要功能，与其他模块 // 或函数的接口，输出值、取值范围、含义及参数间的控 // 制、顺序、独立或依赖等关系 Others: // 其它内容的说明

Function List: // 主要函数列表，每条记录应包括函数名及功能简要说明 1. ....

History: // 修改历史记录列表，每条修改记录应包括修改日期、修改

// 者及修改内容简述 1. Date: Author: Modification:

2. ...

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

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

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

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

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

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

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

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

Table Accessed: // 被访问的表（此项仅对于牵扯到数据库操作的程序）

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

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

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

12-6 ：注释的内容要清楚、明了，含义准确，防止注释二义性 说明：错误的注释不但无益反而有害。

规则2-7 ：避免在注释中使用缩写，特别是非常用缩写 说明：在使用缩写时或之前，应对缩写进行必要的说明。

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

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