Ubuntu16.04安装与使用Doxygen

1 安装Doxygen

[plain] view plain copy
sudo apt-get install doxygen
2 安装Graphviz
根据参考资料[7]的提示，Doxygen使用Graphviz这个工具来绘图：

[plain] view plain copy
sudo apt-get install graphviz
3 标签命令关键字[21]
3.1 文件信息
　 1) @file 文件名(遵守文件命名规则) --> 文件声明，即当前文件名
　 2) @author 作者名 --> 作者
　 3) @version 版本号 --> 版本号
　 4) @todo 说明文字 --> TODO 列表，在相关页面有它专门一项
　 注:只能在实现文件(.c/.cpp)中使用，
　 　 如果相同函数的实现文件与头文件中均有,生成的文档中会有重复项，
　 　 可以理解为调用者不应知道实现流程。
　 5) @date 日期时间 --> 说明文件生成的日期时间
　 6) @section 章节标题 --> @section LICENSE 版权许可 @section DESCRIPTION 描述
3.2 模块信息:
　 1) @defgroup 模块名(英文) 显示名(中文) @{ 类/函数/变量/宏/... @}--> 定义模块
　 2) @ingroup 模块名(英文) [显示名(中文)]--> 作为指定名的模块的子模块,显示名为可选项,
可与指定名的模块的显示名不同。
　 3) @addtogroup 模块名(英文) [显示名(中文)] --> 作为指定名的模块的成员,显示名为可选项,
必需与指定名的模块的显示名相同。
　 4) @name 显示名(中文) @{ 变量/宏 @} --> 按用途分,以便理解全局变量/宏的用途
3.3 函数信息:
　 1) @param 参数名 说明文字 --> 不建议使用这个
　 @param[in] 参数名 说明文字 --> 输入参数
　 @param[out] 参数名 说明文字 --> 输出参数
　 @param[in,out] 参数名 说明文字 --> 即输入又输出参数
　 2) @arg 参数/返回值 说明文字 --> 以列表形式说明参数取值意义
注:也可以用 - 或 -# 来代替,建议此种方法,简单明了。
- 第一级
- 第二级
- 第三级
即相同开头的 - 或 -# 第二行比第一行缩进一个英文空格就变了第二级,依次类推。
- 开头的第一级为实心黑圆点;第二级为空心黑圆点;第三级以后为实心方块;
-# 开头的第一级为数字(1./2./3./...),
第二级为小写字母(a./b./c./...),
第三级为罗马数字(i./ii./iii./...),
第四级为大写字母(A./B./C./...)
　 3) @return 说明文字 --> 返回值说明
　 4) @retval 说明文字 --> 特定返回值说明
　 5) @note 说明文字 --> 注解,可以描述工作流程和注意事项
　 6) @par [段落标题] --> 开创新段落,一般与示例代码联用
　 7) @code --> 示例代码开始
　 8) @endcode --> 示例代码结束
　 9) @see 类/函数/变量/文件/URL --> 参见,
　 类名::函数名 或 ::函数名 可以变成超链接点击跳转到对应函数说明处
　 函数重载的情况下,要带上参数列表以及返回值

1. @deprecated 说明文字 --> 过时列表,在相关页面有它专门一项,
   　 注:只能在头文件(*.h)中使用,如果相同函数的实现文件与头文件中均有,
   　 　 生成的文档中会有重复项,可以理解为维护者不关心这个接口是不是要过时。
2. @pre 说明文字 --> 前置条件
   3.4 提醒信息:
   　 1) @brief 说明文字 --> 摘要,即当前文件/函数说明
   　 2) @attention 说明文字 --> 注意
   　 3) @bug 说明文字 --> 问题
   　 4) @warning 说明文字 --> 警告

参考资料

[1]Doxygen

[2]Doxygen

[3]Doxygen简单经验谈。。。

[4]DOXYGEN简明实用教程

[5]doxygen使用总结

[6]文档生成工具 Doxygen

[7]Linux 平台下阅读源码的工具链

[8]doxygen 使用简介（C,C++为代码作注释）

[9]Doxygen详细介绍

[10]使用Doxygen生成net帮助文档

[11]Doxygen 注释应该写在声明部分还是实现部分

[12] Doxygen按原始注释输出（保留空格和换行）

[13]利用doxygen来管理项目文档或注释

[14]Doxygen C++注释规范及生成帮助文档配置步骤

[15]doxygen规范与配置选项

[16]doxygen的特定命令

[17]doxygen的使用与C/C++注释规范

[18]基于Doxygen的C/C++注释原则

[19]文档生成工具doxygen+图像生成工具GraphViz

[20]如何使用Doxygen为C添加标准化注释

[21]Ubuntu 下使用 Doxygen