Doxygen

Doxygen介绍

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

Doxygen是一个适用于C++、C、Java、Objective-C、Python、IDL（CORBA和Microsoft flavors）、Fortran、VHDL、PHP、C#和D语言的文档生成器。它可以在大多数类Unix 操作系统、macOS以及Microsoft Windows上运行。

安装包下载地址

Doxygen: http://www.doxygen.nl/download.html

Graphviz: http://www.graphviz.org/download/

Microsoft HTML Help Downloads: https://docs.microsoft.com/zh-cn/previous-versions/windows/desktop/htmlhelp/microsoft-html-help-downloads

运行环境 win10 x64

Doxygen的配置

在安装目录下例如：C:\psmyfish\Program\doxygen\bin 中可以找到doxywizard.exe文件，点开即可设置

Doxygen的设置文件存储在默认为Doxyfile的文件内，每次修改设置都需要保存覆盖这个设置文件，当然也可以读取，不表。

下面写设置项

Step 1: 运行目录

Wizard->Project:

source code 源文件夹路径，即脚本文件夹路径.
Scan recursively 勾选，才能扫描子文件夹
generated documentation 产生文件路径

Wizard->Mode:

… mode : All Entities 勾选
…for : 选择脚本所用语言

Wizard->Output：

HTML勾选：如果要产生.chm则选3
LaTex:不选

Wizard->Diagrams

Use dot tool 勾选

Expert->Project

OUTPUT_LANGUAGE 可选输出语言

Expert->Build

EXTRACT_ALL,PRIVATE,STATIC,CLASSES,METHODS勾选

Expert->Input

INPUT_ENCODING

Expert->HTML

CHM_FILE : psmyfish.chm
HHC_LOCATION: C:/psmyfish/Program/HTMLHelp/hhc.exe
CHM_INDEX_ENCODING : GB2312 如果要目录中文此处改

Expert->Dot

CLASS_DIAGRAM 勾选
UML_LOOK 勾选
DOT_PATH C:\whosawbo\Program\Graphviz\bin
DOT_IMAGE_FORMAT jpg or gif

然后可以Run了。