常用注释写法。

例:

/***函数名: RecordIsExist
*作者: jiangjingsong
*日期: 2004-02-22
*功能: 判断当前待插入或更新的记录在原表中是否已经存在
*输入参数: bm (表名) 待查找的 表的名字
* zdm (字段名)在表中待查找的字段
* zdz(字段值) 需要比较的字段的值
*返回值: 类型(boolean)
* 返回true表示当前表中存在一条跟待插入的记录一样的记录;
* 返回false表示当前待插入的记录在表中不存在。
*修改记录:
***/

例:

/***********************************************************************************************
*函数名 :
*函数功能描述 :
*函数参数 :
*函数返回值 :
*作者 :
*函数创建日期 :
*函数修改日期 :
*修改人 :
*修改原因 :
*版本 :
*历史版本 :
***********************************************************************************************/

例:

/***********************************************************************************************
*函数名 : open_file
*函数功能描述 : 打开文件,打开出错会输出定制的错误信息,格式如“[filename:line]: point of error: cause of error”
*函数参数 : pfp-指向文件指针 fname-要打开的文件 mode-打开模式 line-固定使用__LINE__ file-固定使用__FILE__
*函数返回值 : 1-打开文件出错 0-打开文件成功
*作者 : XXX
*函数创建日期 : 2011.4.21
*函数修改日期 : 尚未修改
*修改人 :尚未修改
*修改原因 : 尚未修改
*版本 : 1.0
*历史版本 : 无
***********************************************************************************************/
例:

标准的函数注释格式;

//==================================================================
//函数名: 
//作者:   
//日期:   
//功能:   
//输入参数:
//返回值: 
//修改记录:
//==================================================================

示例:
//==================================================================
//函数名:  RecordIsExist
//作者:   jiangjingsong
//日期:   2004-02-22
//功能:   判断当前待插入或更新的记录在原表中是否已经存在
//输入参数:bm (表名)   待查找的 表的名字
//         zdm (字段名)在表中待查找的字段
//         zdz(字段值) 需要比较的字段的值
//返回值:  类型(boolean)
//         返回true表示当前表中存在一条跟待插入的记录一样的记录;
//         返回false表示当前待插入的记录在表中不存在。
//修改记录:
//==================================================================

发表评论

邮箱地址不会被公开。