c语言编程文件和函数说明模板
一、文件说明模板:
/**************************************************************************
* @brief : 对文件的简单描述
* @author : 作者姓名(邮箱)
* @copyright : 版权信息
* @version : 版本
* @note : 注意事项
* @history : 历史记录
***************************************************************************/
二、函数说明模板:
/**************************************************************************
* @brief : 函数功能的简单描述
* @param[in] : 函数输入参数说明,包括参数名,值的含义,取值范围
* @param[out] : 函数输出参数说明,包括参数名,值的含义,取值范围
* @return : 函数返回值,值的含义,取值范围
* @others : 其它
***************************************************************************/