C语言 - Doxygen代码注释规范

什么是Doxygen ； 他有什么作用？

Doxygen是一种开源跨平台的，以类似JavaDoc风格描述的文档系统，完全支持C、C++、Java、Objective-C和IDL语言，部分支持PHP、C#。注释的语法与Qt-Doc、KDoc和JavaDoc兼容。Doxgen可以从一套归档源文件开始，生成HTML格式的在线类浏览器，或离线的LATEX、RTF参考手册。

Doxygen 是一个程序的文件产生工具，可将程序中的特定批注转换成为说明文件。通常我们在写程序时，或多或少都会写上批注，但是对于其它人而言，要直接探索程序里的批注，与打捞铁达尼号同样的辛苦。大部分有用的批注都是属于针对函式，类别等等的说明。所以，如果能依据程序本身的结构，将批注经过处理重新整理成为一个纯粹的参考手册，对于后面利用您的程序代码的人而言将会减少许多的负担。不过，反过来说，整理文件的工作对于您来说，就是沉重的负担。

Doxygen 就是在您写批注时，稍微按照一些它所制订的规则。接着，他就可以帮您产生出漂亮的文档了。因此，Doxygen 的使用可分为两大部分。首先是特定格式的批注撰写，第二便是利用Doxygen的工具来产生文档。

环境搭建；软件下载

• Doxygen下载 - 下载地址：http://www.onlinedown.net/soft/117010.htm
• htmlhelp下载  - 下载地址：  http://msdn.microsoft.com/en-us/library/ms669985.aspx（如果你希望你的Doxygen自动生成chm，那么请下载HTML Help Workshop，我们将要使用当中的hcc.exe文件以及相关dll。）
• Graphviz的下载 - 下载地址：http://www.skycn.com/soft/appid/6971.html（graphviz 是一个由AT&T实验室启动的开源工具包，用于绘制DOT语言脚本描述的图形。Doxygen 使用 graphviz 自动生成类之间和文件之间的调用关系图，如不需要此功能可不安装该工具包。）

环境搭建；软件应用

在安装好开始配置Doxygen工具，运行Doxywizard。会出现以下界面

 

 

环境搭建；配置工作目录

点击Select选择自己的Doxygen的安装目录

配置Wizard选项卡；配置Project

首先修改Project name，选择扫描源代码的目录，Source code directory：，勾选Scan recursively  （递归扫描），之后选择输出目录。

配置Model

在Wizard的Topics下的Mode，选择All Entities，可以输出相对完整的功能，是否包含源代码看你自身情况，在下面选择好你的语言。这里作者使用的是C++

配置Output

在Output中，如果你需要输出chm格式，请勾选。

配置Diagrams

在Diagrams中选择使用GraphViz包，来输出UML

 

 

 

文章参考：https://blog.****.net/Andy_93/article/details/53125776