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) 
2) 
3) 
4) 
注:只能在实现文件(.c/.cpp)中使用，
如果相同函数的实现文件与头文件中均有,生成的文档中会有重复项，
可以理解为调用者不应知道实现流程。
5) 
6) 
3.2 模块信息:
1) 
2) 
可与指定名的模块的显示名不同。
3) 
必需与指定名的模块的显示名相同。
4) 
3.3 函数信息:
1) 
2) 
注:也可以用 - 或 -# 来代替,建议此种方法,简单明了。
- 第一级
- 第二级
- 第三级
即相同开头的 - 或 -# 第二行比第一行缩进一个英文空格就变了第二级,依次类推。
- 开头的第一级为实心黑圆点;第二级为空心黑圆点;第三级以后为实心方块;
-# 开头的第一级为数字(1./2./3./...),
第二级为小写字母(a./b./c./...),
第三级为罗马数字(i./ii./iii./...),
第四级为大写字母(A./B./C./...)
3) 
4) 
5) 
6) 
7) 
8) 
9) 
类名::函数名 或 ::函数名 可以变成超链接点击跳转到对应函数说明处
函数重载的情况下,要带上参数列表以及返回值
说明文字 --> 过时列表,在相关页面有它专门一项,
注:只能在头文件(*.h)中使用,如果相同函数的实现文件与头文件中均有,
生成的文档中会有重复项,可以理解为维护者不关心这个接口是不是要过时。说明文字 --> 前置条件
3.4 提醒信息:
1)说明文字 --> 摘要,即当前文件/函数说明
2)说明文字 --> 注意
3)说明文字 --> 问题
4)说明文字 --> 警告
参考资料
[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