文件的注释
1：一般情况下，源程序有效注释量必须在20％以上。
说明：注释的原则是有助于对程序的阅读理解，在该加的地方都加了，注释不宜太多也不能太少，注释语言必须准确、易懂、简洁。
2：说明性文件（如头文件.h文件、.inc文件、.def文件、编译说明文件.cfg等）头部应进行注释，注释必须列出：版权说明、版本号、生成日期、作者、内容、功能、与其它文件的关系、修改日志等，头文件的注释中还应有函数功能简要说明。
示例：下面这段头文件的头注释比较标准，当然，并不局限于此格式，但上述信息建议要包含在内。
/*************************************************
Copyright(C), 1988-1999, Huawei Tech. Co.,Ltd.
Filename: // 文件名
Author: Version: Date: // 作者、版本及完成日期
Description: // 用于详细说明此程序文件完成的主要功能，与其他模块
// 或函数的接口，输出值、取值范围、含义及参数间的控
// 制、顺序、独立或依赖等关系
Others: // 其它内容的说明
FunctionList: // 主要函数列表，每条记录应包括函数名及功能简要说明
1. ....
History: // 修改历史记录列表，每条修改记录应包括修改日期、修改
// 者及修改内容简述
1. Date:
Author:
Modification:
2. ...
*************************************************/
3：源文件头部应进行注释，列出：版权说明、版本号、生成日期、作者、模块目的/功能、主要函数及其功能、修改日志等。
示例：下面这段源文件的头注释比较标准，当然，并不局限于此格式，但上述信息建议要包含在内。
/************************************************************
Copyright(C), 1988-1999, Huawei Tech. Co.,Ltd.
FileName:test.cpp
Author: Version: Date:
Description: // 模块描述
Version: // 版本信息
FunctionList: // 主要函数及其功能
1. -------
History: // 历史修改记录
<author> <time> <version > <desc>
David 96/10/12 1.0 build this moudle
***********************************************************/
说明：Description一项描述本文件的内容、功能、内部各部分之间的关系及本文件与其它文件关系等。History是修改历史记录列表，每条修改记录应包括修改日期、修改者及修改内容简述。
4：函数头部应进行注释，列出：函数的目的/功能、输入参数、输出参数、返回值、调用关系（函数、表）等。
示例：下面这段函数的注释比较标准，当然，并不局限于此格式，但上述信息建议要包含在内。
/*************************************************
Function: // 函数名称
Description: // 函数功能、性能等的描述
Calls: // 被本函数调用的函数清单
CalledBy: // 调用本函数的函数清单
Table Accessed:// 被访问的表（此项仅对于牵扯到数据库操作的程序）
TableUpdated: // 被修改的表（此项仅对于牵扯到数据库操作的程序）
Input: // 输入参数说明，包括每个参数的作
// 用、取值说明及参数间关系。
Output: // 对输出参数的说明。
Return: // 函数返回值的说明
Others: // 其它说明
*************************************************/
5：边写代码边注释，修改代码同时修改相应的注释，以保证注释与代码的一致性。不再有用的注释要删除。
6：注释的内容要清楚、明了，含义准确，防止注释二义性。
说明：错误的注释不但无益反而有害。
7：避免在注释中使用缩写，特别是非常用缩写。
说明：在使用缩写时或之前，应对缩写进行必要的说明。
8：注释应与其描述的代码相近，对代码的注释应放在其上方或右方（对单条语句的注释）相邻位置，不可放在下面，如放于上方则需与其上面的代码用空行隔开。
示例：如下例子不符合规范。
例1：
/* get replicatesubsystem 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 replicatesubsystem index and net indicator */
应如下书写
/* get replicatesubsystem index and net indicator */
repssn_ind=ssn_data[index].repssn_index;
repssn_ni=ssn_data[index].ni;
9：对于所有有物理含义的变量、常量，如果其命名不是充分自注释的，在声明时都必须加以注释，说明其物理含义。变量、常量、宏的注释应放在其上方相邻位置或右方。
示例：
/* activestatistictask number */
#defineMAX_ACT_TASK_NUMBER1000
#define MAX_ACT_TASK_NUMBER1000 /* active statistictask number */
10：数据结构声明(包括数组、结构、类、枚举等)，如果其命名不是充分自注释的，必须加以注释。对数据结构的注释应放在其上方相邻位置，不可放在下面；对结构中的每个域的注释放在此域的右方。
示例：可按如下形式说明枚举/数据/联合结构。
/* sccpinterfacewith sccp user primitive message name */
enum SCCP_USER_PRIMITIVE
{
N_UNITDATA_IND, /* sccp notify sccp userunit data come */
N_NOTICE_IND, /* sccp notify user the No.7 network can not*/
/* transmission thismessage */
N_UNITDATA_REQ, /* sccp user's unit datatransmission request*/
};
11：全局变量要有较详细的注释，包括对其功能、取值范围、哪些函数或过程存取它以及存取时注意事项等的说明。
示例：
/* The ErrorCodewhenSCCP translate */
/* GlobalTitlefailure, as follows */ // 变量作用、含义
/* 0 － SUCCESS 1 － GT Table error */
/* 2 － GT error Others － nouse */ // 变量取值范围
/* only function SCCPTranslate() in */
/* this modualcanmodify it, and other */
/* module canvisitit through call */
/* the function GetGTTransErrorCode() */ // 使用方法
BYTEg_GTTranErrorCode;
12：注释与所描述内容进行同样的缩排。
说明：可使程序排版整齐，并方便注释的阅读与理解。
示例：如下例子，排版不整齐，阅读稍感不方便。
voidexample_fun(void )
{
/* code onecomments*/
CodeBlock One
/* code two comments */
CodeBlock Two
}
应改为如下布局。
voidexample_fun(void )
{
/* code one comments */
CodeBlock One
/* code two comments */
CodeBlock Two
}
示例：如下例子，显得代码过于紧凑。
/* code onecomments*/
program code one
/* code twocomments*/
program code two
应如下书写
/* code onecomments*/
program code one
/* code twocomments*/
program code two
14：对变量的定义和分支语句（条件分支、循环语句等）必须编写注释。
说明：这些语句往往是程序实现某一特定功能的关键，对于维护人员来说，良好的注释帮助更好的理解程序，有时甚至优于看设计文档。
15：对于switch语句下的case语句，如果因为特殊情况需要处理完一个case后进入下一个case处理，必须在该case语句处理完、下一个case语句前加上明确的注释。
说明：这样比较清楚程序编写者的意图，有效防止无故遗漏break语句。
示例（注意斜体加粗部分）：
caseCMD_UP:
ProcessUp();
break;
case CMD_DOWN:
ProcessDown();
break;
caseCMD_FWD:
ProcessFwd();
if (...)
{
...
break;
}
else
{
ProcessCFW_B(); // now jump into case CMD_A
}
caseCMD_A:
ProcessA();
break;
caseCMD_B:
ProcessB();
break;
caseCMD_C:
ProcessC();
break;
caseCMD_D:
ProcessD();
break;
...
16.注释格式尽量统一，建议使用“/* ……*/”。
17.注释应考虑程序易读及外观排版的因素，使用的语言若是中、英兼有的，建议多使用中文，除非能用非常流利准确的英文表达。
毫无疑问现在我们的程序是不规范的。为了以后的协作，规范化程序很有必要。
1. 参考文档有三个：
l 匈牙利命名法则：http://blog.youkuaiyun.com/haiross/article/details/45147993
l 编程规范-注释：http://blog.youkuaiyun.com/xiaoxiaopengbo/article/details/51583631（主要参考这个）
l 高质量C++/C编程指南.pdf
这些都是基于C语言写的。我们可以参考着用，方法如下：
2. 命名：对于“变量”，我们需要统一命名为：数据类型+英文单词（首字母大写）；如果这个变量用2个或以上的英文单词来表达，就用前2个英文单词，每个单词首字母大写，中间用下划线分开。
a) 例如：整数类型的“交易周期”int_Trading_Duration；又或者简写为int_Trad_Dura
b) 注：变量名的英文，可以参考百度翻译，错了不要紧，重点是“有意义”
3. 注释：严格参考编程规范-注释：http://blog.youkuaiyun.com/xiaoxiaopengbo/article/details/51583631，尤其是写好“变量”、“函数”的注释，还有总体注释。
a) 特别提醒：一定要有版本号和日期，方便日后核对。
扫一扫
921
被折叠的 条评论
为什么被折叠?
到【灌水乐园】发言
