简述
该参考是基于Doxygen注释规范进行简单归纳,可以适当根据自己的需求进行约定。
Doxygen可以从一套归档源文件开始,生成HTML格式的在线类浏览器,或离线的LATEX、RTF参考手册。简单来说就是一个程序的文件产生工具,可将程序中的特定注释转换成为说明文件。
注释规范内容
1. 简单注释
(1) 单行注释
///
(2) 多行注释
/**
2. 文件注释
/***@file 文件名*@brief 简介*@datails 细节*@mainpage 工程概览*@autor 作者*@email 邮箱*@version 版本号*@date 年-月-日*@license 版权*/
3. 常量/变量注释
(1)代码前注释
///注释
变量/常量定义
(2)代码后注释
变量/常量定义 ///
4. 函数注释
下面是函数的详细注释,可根据实际情况增减相关条目。
/***@brief 函数简介*@datail 详细说明**@param 形参 参数说明*@param 形参 参数说明*@return 返回说明*@retval 返回值说明*@note 注解*@attention 注意*@warning 警告*@exception异常*/
5. 其他内容注释
命令 生成字段名 说明
@see 参考
@class 应用类 用于文档生成连接
@var 引用变量 用于文档生成连接
@enum 引用枚举 用于文档生成连接
@code 代码块开始 与@endcode成对使用
@endcode 代码块接收 与@code成对使用
@bug 缺陷
@todo
@example 使用例子说明
@remarks 备注说明
@pre 函数前置条件
@deprecated 函数过时说明