C++ 规范注释

来源:互联网 发布:java 获取对象属性名 编辑:程序博客网 时间:2024/06/08 14:38

源文件头部注释? 列出:版权、作者、编写日期和描述。
? 示例:
/*************************************************
Copyright:bupt
Author:
Date:2010-08-25
Description:描述主要实现的功能
**************************************************/
每行不要超过80个字符的宽度。
2 函数头部注释? 列出:函数的目的/功能、输入参数、输出参数、返回值、调用关系(函数、表)等。
? 示例:下面这段函数的注释比较标准,当然,并不局限于此格式,但上述信息建议
要包含在内。

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

Function: // 函数名称

Description: // 函数功能、性能等的描述

Calls: // 被本函数调用的函数清单

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

Table Updated: // 被修改的表(此项仅对于牵扯到数据库操作的程序)

Input: // 输入参数说明,包括每个参数的作

// 用、取值说明及参数间关系。

Output: // 对输出参数的说明。

Return: // 函数返回值的说明

Others: // 其它说明

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

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

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

/* sccp interface with sccp user primitive message name */
enum SCCP_USER_PRIMITIVE 
{
N_UNITDATA_IND, /* sccp notify sccp user unit data come */

原创粉丝点击