比较全面的函数注释规范

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

 

 

例：

/***********************************************************************************************
*函数名 : 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
*历史版本 : 无
***********************************************************************************************/

int open_file(FILE **pfp, const char *const fname, const char *const mode, const int line, const char *const file)
{
 *pfp = fopen(fname, mode);

 if (NULL == *pfp)
 {
  fprintf(stderr, "[%s:%d]: fopen() failed: %s/n", file, line, strerror(errno));
  return 1;
 }

 return 0;
}