c语⾔表⽰注释,c语⾔中注释的位置
匿名⽤户
1级
2011-10-21 回答
1 注释的原则和⽬的注释的原则是有助于对程序的阅读理解，在该加的地⽅都加了，注释不宜太多也不能太少，注释语⾔必须准确、易懂、简洁。通过对函数或过程、变量、结构等正确的命名以及合理地组织代码的结构，使代码成为⾃注释的——清晰准确的函数、变量等的命名，可增加代码可读性，并减少不必要的注释——过量的注释则是有害的。
注释的⽬的是解释代码的⽬的、功能和采⽤的⽅法，提供代码以外的信息，帮助读者理解代码，防⽌没必要的重复注释信息。 ⽰例：如下注释意义不⼤。
/* if receive_flag is TRUE */
if (receive_flag)
⽽如下的注释则给出了额外有⽤的信息。
/* if mtp receive a message from links */
if (receive_flag)
2 函数头部应进⾏注释函数头部应进⾏注释，列出：函数的⽬的/ 功能、输⼊参数、输出参数、返回值、调⽤关系(函数、表)等。
⽰例1：下⾯这段函数的注释⽐较标准，当然，并不局限于此格式，但上述信息建议要包含在内。
/*************************************************
Function: // 函数名称
Description: // 函数功能、性能等的描述
Calls: // 被本函数调⽤的函数清单
Called By: // 调⽤本函数的函数清单
Input: // 输⼊参数说明，包括每个参数的作
// ⽤、取值说明及参数间关系。
Output: // 对输出参数的说明。
Return: // 函数返回值的说明switch语句表示范围
Others: // 其它说明
*************************************************/
对于某些函数，其部分参数为传⼊值，⽽部分参数为传出值，所以对参数要详细说明该参数是⼊⼝参数，还是出⼝参数，对于某些意义不明确的参数还要做详细说明 (例如：以⾓度作为参数时，要说明该⾓度参数是以弧度(PI)，还是以度为单位)，对既是⼊⼝⼜是出⼝的变量应该在⼊⼝和出⼝处同时标明。等等。
在注释中详细注明函数的适当调⽤⽅法，对于返回值的处理⽅法等。在注释中要强调调⽤时的危险⽅⾯，可能出错的地⽅。
3 进⾏注释时的注意事项(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)注释应考虑程序易读及外观排版的因素，使⽤的语⾔若是中、英兼有的，建议多使⽤中⽂，除⾮能⽤⾮常流利准确的英⽂表达——注释语⾔不统⼀，影响程序易读性和外观排版，出于对维护⼈员的考虑，建议使⽤中⽂。

版权声明：本站内容均来自互联网，仅供演示用，请勿用于商业和其他非法用途。如果侵犯了您的权益请与我们联系QQ:729038198，我们将在24小时内删除。