强大的Doxygen工具使用手册(中文帮助)
张三:假如我们自己开发了一个类库,怎么做一个方便阅读的文档呢?
李四:一个方法一个方法地写呗,就像写Excel文档一下。
张三:啊,你out了,这多慢呀。为什么不玩玩doxygen工具,它能帮你生成文档?
李四:这么爽,什么东东,给说讲讲。
1. Doxygen, what?
Doxgen就是大名鼎鼎的文档生成工具,而且是免费开源的,它使用非常方便,能提取C++,Java,Objective-C,Python,IDL,PHP,C#等语言的注释,从而生成文档。
你可以访问其官方网站,下载安装包,它的官网上有详细的使用手册。
支持的主要语言格式
Extension | Language |
.idl | IDL |
.ddl | IDL |
.odl | IDL |
.java | Java |
.cs | C# |
.c | C |
.cpp | C++ |
可产生出来的文档格式有:
HTMLXMLLaTeXRTFCHM
要让工具能提取注释,那么就要求你写的注释要按照一定的规则来写,不能乱写,不然该工具是无法识别的,通常在Java中,只要JavaDoc能识别的,doxgen也能识别。
2. 安装Doxygen
我们可以在这个网址去下载最新的安装包
安装过程就不用说了,很简单,直接Next,最后Finish就OK了。
3. 配置Doxygen
配置doxgen是最核心的,你可以设置你要提取注释的源文件,生成的文档格式,工程名称,文档的Logo等信息,这些配置是可以存储起来的,当你的源代码更新后,重新再运行这个配置文件,就可以重新生成一个新的文档。
在安装后,进入到其安装目录下的bin文件夹,它里面有两个文件:doxygen.exe和doxywizard.exe,我们先运行doxywizard.exe来进行配置,从而生成配置文件(如果是第一次运行)。
图1,Doxygen配置主界面。
1,Doxygen工作目录,就是用来存储配置文件的目录。
2,递归搜索目录需要选上。
图2,选择输出文档格式
图3,生成类图
图4,选择文档的编码格式。
说明:编码格式,UTF-8 是首选。如果需要显示中文则选择GB2313。
图5,设置提取的范围。
图6,设置源码的格式。
图7,设置生成CHM文件属性。
图8,配置完成后,点击"Run doxygen"来运行配置,最后,点击File->Save存储配置文件,下次就不用再配置了。
4. 输出文档示例
下面的图片示例了输出的文档格式(HTML),很简单实用,同时还能支持Search。
图9,列出所有的包名。
图10,具体某一个类的详细注释,可以列出所有的公有方法,你的代码注释写得越详细,那么生成的文档也就越详细。