c语言编程规范——2 注释-凯发app官方网站

2 注释

2.1 注释的原则

注释的目的是解释代码的目的、功能和采用的方法，提供代码以外的信息，帮助读者理解代码，防止没必要的重复注释信息。 示例：如下注释意义不大。

/* if receive_flag is true */

if (receive_flag)

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

/* if mtp receive a message from links */

if (receive_flag)

2.2 说明性文件头部应进行注释

说明性文件(如头文件.h 文件、.inc 文件、.def 文件、编译说明文件.cfg 等)头部应进行注释，注释要列出：凯发k8官网下载客户端中心的版权说明、版本号、生成日期、作者、内容、功能、与其它文件的关系、修改日志等，头文件的注释中还应有函数功能简要说明。

2.3 源文件头部应进行注释

源文件头部应进行注释，列出：凯发k8官网下载客户端中心的版权说明、版本号、生成日期、作者、模块目的/功能、主要函数及其功能、修改日志等。

2.4 函数头部应进行注释

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

对于某些函数，其部分参数为传入值，而部分参数为传出值，所以对参数要详细说明该参数是入口参数，还是出口参数，对于某些意义不明确的参数还要做详细说明(例如：以角度作为参数时，要说明该角度参数是以弧度(pi),还是以度为单位),对既是入口又是出口的变量应该在入口和出口处同时标明。等等。

在注释中详细注明函数的适当调用方法，对于返回值的处理方法等。在注释中要强调调用时的危险方面，可能出错的地方。

2.5 进行注释时的注意事项

(1)建议边写代码边注释，修改代码同时修改相应的注释，以保证注释与代码的一致性。不再有用的注释要删除。

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

(3)避免在注释中使用缩写，特别是非常用缩写。在使用缩写时或之前，应对缩写进行必要的说明。

(4)注释应与其描述的代码相近，对代码的注释应放在其上方或右方(对单条语句的注释)相邻位置，不可放在下面。除非必要，不应在代码或表达中间插入注释，否则容易使代码可理解性变差。

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

例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;

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

示例：

/* active statistic task number */

#define max_act_task_number 1000

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

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

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

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

};

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

示例：

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

(8)注释与所描述内容进行同样的缩排，让程序排版整齐，并方便注释的阅读与理解。

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

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

}

(9)将注释与其上面的代码用空行隔开。

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

/* code one comments */

program code one

/* code two comments */

program code two

应如下书写

/* code one comments */

program code one

/* code two comments */

program code two

(10)对变量的定义和分支语句(条件分支、循环语句等)必须编写注释。这些语句往往是程序实现某一特定功能的关键，对于维护人员来说，良好的注释帮助更好的理解程序，有时甚至优于看设计文档。

(11)对于switch 语句下的case 语句，如果因为特殊情况需要处理完一个case 后进入下一个case 处理(即上一个case后无break)，必须在该case 语句处理完、下一个case 语句前加上明确的注释，以清楚表达程序编写者的意图，有效防止无故遗漏break语句(可避免后期维护人员对此感到迷惑：原程序员是遗漏了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;

...

(12)在程序块的结束行右方加注释标记，以表明某程序块的结束。当代码段较长，特别是多重嵌套时，这样做可以使代码更清晰，更便于阅读。示例：参见如下例子。

if (...)

{

program code

while (index < max_index)

{

program code

} /* end of while (index < max_index) */ // 指明该条while语句结束

} /* end of  if (...)*/ // 指明是哪条if语句结束

(13)在顺序执行的程序中，每隔3—5行语句，应当加一个注释，注明这一段语句所组成的小模块的作用。对于自己的一些比较独特的思想要求在注释中标明。

(14)注释格式尽量统一，建议使用“/* …… */”。

(15)注释应考虑程序易读及外观排版的因素，使用的语言若是中、英兼有的，建议多使用中文，除非能用非常流利准确的英文表达——注释语言不统一，影响程序易读性和外观排版，出于对维护人员的考虑，建议使用中文。