doxygen 使用 + C/C++注释规范
1、安装
yum -y install doxygen #基本安装
yum -y install doxygen-doxywizard #图形界面安装
2、生成配置文件
doxygen -g [配置文件名] #默认文件名为Doxyfile
3、配置文件
好多选项呀,1500行,懒得看 –,这个是一个巨大的工作量。
大部分默认,需要改的是输入/输出文件的位置、格式,要输出那些内容。
其实最懒的方法是用图形界面配置~ ~f
4、C注释规范
4.1 注释风格
- 风格1,默认风格
/*! \brief 简要描述
*
* 详细描述
*/
- 风格2,QT风格
//! 简要描述
/*!
* 详细描述
*/
- 风格3,JavaDoc风格
/** 简要描述 . 详细描述(以'.'作为分隔符)
*
*/
注:个人喜欢风格2,QT风格~~,不同风格之间也可灵活组合,JavaDOC风格需要修改配置文件里的一个选项,不喜。。。
- 类、结构的成员描述
int a; /*!< 内容 */
4.2 不同种类的标签
标签中的\可替换成@,个人喜欢\,然感觉@更清晰一点点
* \author 作者
* \brief 摘要
* \version 版本号
* \date 日期
* \file 文件
* \class 类
* \struct 结构
* \param 函数参数
* \return 函数返回值
* \exception 函数抛异常
* \warning 函数使用需要注意的地方
* \remarks 备注
* \see see also字段
* \note 详细描述,摘要后可用note而不用空行表示
* \par 开始一个段落,段落名自定义,如写一段示例代码
* \code 引用代码段
* \endcode 代码段结束
* \pre 函数前置条件,如对参数的要求
* \post 函数后置条件,如对系统状态的影响、返回值的预期
以下是不太常用的。。
* \defgroup 模块名
* \name 分组名
* \{ 模块开始
* \} 模块结束
* \since 那个版本后开始有这个函数
* \todo 标记代码会在todo列表中出现
* \bug 标记代码会在test列表中出现
* - 一级项目符号
* -# 二级项目符号
4.2 例子模板
- 文件
//! 摘要
/*!
\file 文件名
\author 作者
\version 版本
\date 日期
\note 注解(我把这个当详细描述用的--) \n
'\n' 可以换行 ~~!
*/