DoxyGen使用

DoxyGen使用初体验(一)

Doxygen 是一个程序的文件产生工具，可将程序中的特定批注转换成为说明文件。Doxygen 就是这样的一个工具。在您写批注时，稍微按照一些它所制订的规则。接着，他就可以帮您产生出漂亮的文件了。

    1.DoxyGen的注释类型，这里只介绍Qt类型(我自己用着顺手一点):

多行注释:

/*!

 * ... 程序注释...

 */

单行注释:

//! 这是一个简洁型的注释

    2.常用注释参数:

@file	档案的批注说明
@author	作者的信息
@brief	用于class或function的批注中,后边为class或function的批注说明
@param	格式为: @param arg name 主要用于函式说明中,后边接参数的名字,然后再接关于参数的说明
@return	接函数返回值的说明，用于function的批注中
@retval	格式为：@retval value 传回值说明 主要用于函式说明中，说明特定传回值的意义。所以后面要先接一个传回值。然后在放该传回值的说明。

    3.使用:

  a.在命令提示符中cd到doxygen.exe所在的目录，然后doxygen -g fileName,生成一个名为fileName的配置文件模板。

  以notepad打开fileName，修改里边的参数，主要如下：

 

PROJECT_NAME                = xstring

PROJECT_NUMBER = 0.31

OUTPUT_DIRECTORY         = E:\xstring

OUTPUT_LANGUAGE         = English

         INPUT                                 = E:\xstring

运行Doxygen.exe Doxyfile就可以在E:\xstring\html目录下生成xstring类的文档。

b.或者在doxygenwizard中打开filename，然后主要在Project、Input、Index、html、latex、dot中设置一些参数(略)，保存然后run。

具体我引用别人的:

  假设你的plog source放在d:/plog
Project Name 打上 plog
Project Number 打上 0.31
假设你的 document 输出到 d:/plog/docs
create sub_dirs 不要勾，它有一点bug 
output， lang 选中文 ( Chinese_Traditiona) 
切换 tab 到 build
这是要选择输出document的详细情况.
切换到 Input
选择 d:/plog 切回input
下面的 file pattern，指定我们只分析.php还是.html还是.c,没有的情况下，全部分析
再來 recursive 一定要打勾
(代表下面的每一個子目录都要分析)
切换到 source browse
之前只是指定要产生 document, 但 doxygen 允许你将 doc & source 放在一起, 比较好看, 我的习惯是全部 include, 所以产生的文件比较大, 但好处是不用再去翻 source code.
切换到 index
決定要不要索引，你可以打勾
另外索引要显示成几栏, 基本上 3 栏就很大了, 5 栏会超出屏幕很多.

切换到HTML
要选择输出的文件格式, 基本上只要 HTML , 看一看有什麼要改的, 原則上不动就可以了. 
切换到 Latex
把latex 取消
跳到 dot
这个tab,doxygen 会产生很详细的 class digram & activity diagram, 但是要有一些 library support, 如果没有装library, 他只会产生 class diagram, 所以这一页看看就好, 也不用去动他.
设定完成后, 按一下 save,保存设定，然后run.

 

注意:我发现好像input source和output中的路径如果使用了中文都会run不成功，所以建议采用全字母路径。