以注释内容开始。
关于程序中注释书写格式
1程序文件注释：
放在程序名称空间引用（using System.IO）的上面，主要写公司的版权、文件创建的时间、文件的主要内容、文件的名字、文件的创建标识（创建人姓名）、文件修改的时间、文件修改时的修改标识（修改人姓名）、文件修改的修改原因等（详情见文档后备注示例）；
2类的作用注释：
放在类（类、接口、枚举、结构体）的声明上方，主要描述类的作用。
如果早伏类的结构比较复杂，也应该添加类的使用示例和类的流程（其它特点）
3、类的私有全局重要变量注释：
放在类的全局变量声明上方，主要需要注释通过命名不能正确理解的全局私有或公有（包含受保护等）变量。如果是object（特殊数组等）型变量，内部使用时结构比较复杂或有规定陆宽携，需要简要的说明一下内部结构。
4、类的属性的注释：
放在类的属性声明上方，简要说明属性的类型和主要作用。
5、类的公有方法的注释：
主要说明方法的作用，方法各参数的意义和要求，方法的返回值及各种可能的返回值的特殊意义，方法可能会产生的异常，如果需要，则可以写出方法的使用示例；
6、类的私有方法或重要算法的注释：
除了需要说明公有方法所要求的之外，如果算法、数学运算比较复杂，需要写出算法或数学方法的理论过程或推导过程；如果算法比较长，要尽可能的细分成逻辑块，并填写适当的注释；对于方法中的重要变量也要添加适当的注释，特别是对方法的结果或方法某一段的结果的方法内部不易理解的变量要添加合适的注释；对于特别复杂（重要）的方法，要添加适当的流程图或文档，给以充分的文字、图解等说明；
7、文件、类或类的方法修改后的注释的变更：
对于对文件或类（包括接口、枚举、结构体）或类的方法修改后，要添加修改后的相注释，要写巧游清修改的时间、修改标识（修改人姓名）、修改的原因等一切必要的信息和一切必要变更的信息（类、方法的流程）；
C语言编程规范-注释规则:
1：一般情况下，源程序有效注释量必须在20％以上。
说明：注释的原则是有助于对程序的阅读理解，在该加的地方都加了，注释不宜太多也不能太少，注释语言必须准确、易懂、简洁。
2：说明性文件（如头文件.h文件、.inc文件、.def文件、编译说明文件.cfg等）头部应进行注释，注释必须列出：版权棚肆扰说明、版本号、生成日期、作者、内容、功能、与其它文件的关系、修改日志等，头文件的注释中还应有函数功能简要说明。
示例：下面这段头文件的头注释比较标准，当然，并不局限于此格式，但上述信息建议要包含在内。
/*************************************************
Copyright (C), 1988-1999, Tech. Co., Ltd.
File name: // 文件名
Author:
Version:
Date: // 作者、版本及完成日期
Description:// 用于详细说明此程序文件完成的主要功能，与其他模块
// 或函数的接口，输出值、取值范围、含义及参数间的控
// 制、顺序、独立或依赖等关系链旦
Others:// 其它内容的说明
Function List: // 主要函数列表，每条记录应包括函数名及功能简要说明
1. ....
History:// 修改历史记录列表，每条修改记录应包括修改日期、修改
// 者及修改内容简述
1. Date:
Author:
Modification:
2. ...
*************************************************/
3：源文件头部应进行注释，列出：版权说明、版本号、生成日期、作者、模块目的/功能、主要函数及其功能、修改日志等。
示例：下面这段源文件的头注释比较标准，当然，并不局限于此格式，但上述信息建议要雹悄包含在内。
/************************************************************
Copyright (C), 1988-1999, Tech. Co., Ltd.
FileName: test.cpp
Author:
Version :
Date:
Description:// 模块描述
Version:// 版本信息
Function List: // 主要函数及其功能
1. -------
History:// 历史修改记录
<author> <time> <version > <desc>
David96/10/121.0build this moudle
***********************************************************/
说明：Description一项描述本文件的内容、功能、内部各部分之间的关系及本文件与其它文件关系等。History是修改历史记录列表，每条修改记录应包括修改日期、修改者及修改内容简述。
4：函数头部应进行注释，列出：函数的目的/功能、输入参数、输出参数、返回值、调用关系（函数、表）等。
示例：下面这段函数的注释比较标准，当然，并不局限于此格式，但上述信息建议要包含在内。
/*************************************************
Function: // 函数名称
Description:// 函数功能、性能等的描述
Calls: // 被本函数调用的函数清单
Called By: // 调用本函数的函数清单
Table Accessed: // 被访问的表（此项仅对于牵扯到数据库 *** 作的程序）
Table Updated: // 被修改的表（此项仅对于牵扯到数据库 *** 作的程序）
Input: // 输入参数说明，包括每个参数的作
// 用、取值说明及参数间关系。
Output:// 对输出参数的说明。
Return:// 函数返回值的说明
Others:// 其它说明
*************************************************/
5：边写代码边注释，修改代码同时修改相应的注释，以保证注释与代码的一致性。不再有用的注释要删除。
6：注释的内容要清楚、明了，含义准确，防止注释二义性。
说明：错误的注释不但无益反而有害。
7：避免在注释中使用缩写，特别是非常用缩写。
说明：在使用缩写时或之前，应对缩写进行必要的说明。
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
9：对于所有有物理含义的变量、常量，如果其命名不是充分自注释的，在声明时都必须加以注释，说明其物理含义。变量、常量、宏的注释应放在其上方相邻位置或右方。
示例：
/* active statistic task number */
#define MAX_ACT_TASK_NUMBER 1000
#define MAX_ACT_TASK_NUMBER 1000 /* active statistic task number */
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*/
}
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
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
}
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
14：对变量的定义和分支语句（条件分支、循环语句等）必须编写注释。
说明：这些语句往往是程序实现某一特定功能的关键，对于维护人员来说，良好的注释帮助更好的理解程序，有时甚至优于看设计文档。
15：对于switch语句下的case语句，如果因为特殊情况需要处理完一个case后进入下一个case处理，必须在该case语句处理完、下一个case语句前加上明确的注释。
说明：这样比较清楚程序编写者的意图，有效防止无故遗漏break语句。
示例（注意斜体加粗部分）：
case CMD_UP:
ProcessUp()
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
case CMD_B:
ProcessB()
break
case CMD_C:
ProcessC()
break
case CMD_D:
ProcessD()
break
...
建议:
1：避免在一行代码或表达式的中间插入注释。
说明：除非必要，不应在代码或表达中间插入注释，否则容易使代码可理解性变差。
2：通过对函数或过程、变量、结构等正确的命名以及合理地组织代码的结构，使代码成为自注释的。
说明：清晰准确的函数、变量等的命名，可增加代码可读性，并减少不必要的注释。
3：在代码的功能、意图层次上进行注释，提供有用、额外的信息。
说明：注释的目的是解释代码的目的、功能和采用的方法，提供代码以外的信息，帮助读者理解代码，防止没必要的重复注释信息。
示例：如下注释意义不大。
/* if receive_flag is TRUE */
if (receive_flag)
而如下的注释则给出了额外有用的信息。
/* if mtp receive a message from links */
if (receive_flag)
4：在程序块的结束行右方加注释标记，以表明某程序块的结束。
说明：当代码段较长，特别是多重嵌套时，这样做可以使代码更清晰，更便于阅读。
示例：参见如下例子。
if (...)
{
// program code
while (index <MAX_INDEX)
{
// program code
} /* end of while (index <MAX_INDEX) */ // 指明该条while语句结束
} /* end of if (...)*/ // 指明是哪条if语句结束
5：注释格式尽量统一，建议使用"/* …… */"。
6：注释应考虑程序易读及外观排版的因素，使用的语言若是中、英兼有的，建议多使用中文，除非能用非常流利准确的英文表达。
说明：注释语言不统一，影响程序易读性和外观排版，出于对维护人员的考虑，建议使用中文。
一般来讲有两来种：一是单行注释：直接在该行需要注释的地方加上"//"就行了。例如：
"int
a,b//这是一个注释自行"。那么，弯歼宏"//"后面百的部分"这是一个注释行"就被注度释掉了，不起作用，但是埋册"//"前改清面的“int
a,b"不受影响。
另外还有一种是多行问同时注答释：
/*
int
a,b
int
c,d
*/
其中"/*"和"*/"起限定范围的作用，该范围内的语句都会被注释掉，将不再起作用。当然，多行注释也是可以用来单行注释的
欢迎分享，转载请注明来源：内存溢出
微信扫一扫
支付宝扫一扫
评论列表（0条）