lyfz_repos/经典版源码/document/其他文档/函数注释模板.txt

Jeff 21:01 2015/4/18

所有函数注释,都按以下格式进行扩展,做到在公司内所有源码统一注释.


/************************************************************************/
/* 
	函数：
	描述：
	参数：
	    [IN]
	    [OUT]
	返回：

	注意：
	要求：
	示例：
		
	修改：	
	日期：
	内容：
*/
/************************************************************************/

示例：
/************************************************************************/
/* 
	作者:Jeff
	时间:07:56 2015/2/18
	函数:GetFileSpace
	描述:获取文件磁盘占用空间大小,单位字节;
	参数:
	     IN:lpFileName 文件名;
	     OUT: uFileSpacesSize 文件占用磁盘空间大小;	
	返回:成功则返回文件的大小,否则返回-1;
	注意:该函数如果使用VC6.0编译器会编译失败,需要手动包含某些API函数头文件和Lib库;
	要求:无(使用函数的环境要求)
	示例:无
	
	修改:Jeff
	时间:20:04 2015/3/18
	内容:升级函数可在64位系统下执行.

	修改:Jeff
	时间:21:06 2015/4/18
	内容:优化函数运行效率
*/
/************************************************************************/

参数前缀：arg
指针参数：arg
整型参数：arg

VAssistX中设置注释模板：
//v
/************************************************************************/
/*  Copyright (C), 2016-2020, [%USERNAME%], 保留所有权利;
/*  模 块 名：;
/*  描    述：;
/*
/*  版    本：[V];	
/*  作    者：[%USERNAME%];
/*  日    期：[$MONTH$/$DAY$/$YEAR$];
/*
/*
/*  注    意：;
/*
/*  修改记录：[%USERNAME%];
/*  修改日期：;
/*  修改版本：;
/*  修改内容：;
/************************************************************************/

//f
/************************************************************************/
/*  函数：[$MONTH$/$DAY$/$YEAR$ %USERNAME%];
/*  描述：;
/*  参数：;
/*  	[IN] ：;
/*  	[OUT] ：;
/*  	[IN/OUT] ：;
/*  返回：void;
/*  注意：;
/*  示例：;
/*
/*  修改：;
/*  日期：;
/*  内容：;
/************************************************************************/