帮助文档生成器doxygen windows 1.8.13

doxygen是一款办这个户用户将代码中的注释编程帮助文档的软件，目前这款工具支持现在许多流行的编程语言，虽然这是一款源生的C++文档生成标准工具，不过目前也支持C、PHP、C#、Java等等语言，如果用户想要用最简单的方式生成帮助文档的话，这款软件能够帮助到你。
doxygen因为是直接从源中进行提取的，所以用户的文档能够保持和源代码一直，不管代码如何变动都会自动为用户生成最新最准确的文档，完全不需要用户操心。你还可以配置软件从未记录的原文件代码提取结构，这样即使用户遇到一些软件不能够提取的东西，通过自己的设置也能够进行提取，非常强大且好用，有需要的用户不要错过哦。

使用方法

一、Doxygen的主页面
首先修改Project name，选择扫描源代码的目录，Source code directory：勾选Scan recursively：

二、在Wizard的Topics下的Mode，选择All Entities，可以输出相对完整的功能，是否包含源代码看自身情况，在下面选择好自己的语言。这里得是C所以选择C or PHP

三、在Output中，如果你需要输出chm格式，勾选chm,没有要求的话html就可以了

四、在Diagrams中选择使用GraphViz包，来输出UML，GraphViz包可以帮助建立一些树状视图。

五、Expert中，你需要首选确定你所输出的语言，个人使用中文在Expert的Input中，很重要的是INPUT_ENCODING项，如果使用的为微软默认字符集请填写GBK，不然目录乱码,当前选择UTF-8，输出语言选择的是Chinese.

六、Build页面，这个页面是生成帮助信息中比较关键的配置页面：
EXTRACT_ALL 表示：输出所有的函数，但是private和static函数不属于其管制。
EXTRACT_PRIVATE 表示：输出private函数。
EXTRACT_STATIC 表示：输出static函数。同时还有几个EXTRACT，相应查看文档即可。
HIDE_UNDOC_MEMBERS 表示：那些没有使用doxygen格式描述的文档（函数或类等）就不显示了。当然，如果EXTRACT_ALL被启用，那么这个标志其实是被忽略的。
INTERNAL_DOCS 主要指：是否输出注解中的@internal部分。如果没有被启动，那么注解中所有的@internal部分都将在目标帮助中不可见。
CASE_SENSE_NAMES 表示：是否关注大小写名称，注意，如果开启了，那么所有的名称都将被小写。对于C/C++这种字母相关的语言来说，建议永远不要开启。
HIDE_SCOPE_NAMES 表示：域隐藏，建议永远不要开启。
SHOW_INCLUDE_FILES 表示：是否显示包含文件，如果开启，帮助中会专门生成一个页面，里面包含所有包含文件的列表。
INLINE_INFO ：如果开启，那么在帮助文档中，inline函数前面会有一个inline修饰词来标明。
SORT_MEMBER_DOCS ：如果开启，那么在帮助文档列表显示的时候，函数名称会排序，否则按照解释的顺序显示。
GENERATE_TODOLIST ：是否生成TODOLIST页面，如果开启，那么包含在@todo注解中的内容将会单独生成并显示在一个页面中，其他的GENERATE选项同。
SHOW_USED_FILES ：是否在函数或类等的帮助中，最下面显示函数或类的来源文件。
SHOW_FILES ：是否显示文件列表页面，如果开启，那么帮助中会存在一个一个文件列表索引页面。

七、Expert>Input页按照下图进行设置调整参数。

1.如果在 Wizard 的 Output Topics 中选择了 prepare for compressed HTML (.chm)选项，此处就会要求选择 hhc.exe 程序的位置。在 windows help workshop 安装目录下可以找到 hhc.exe。
2.为了解决Doxygen生成的CHM文件的左边树目录的中文变成了乱码，CHM_INDEX_ENCODING中输入GB2312即可。
3.GENERATE_CHI 表示索引文件是否单独输出，建议关闭。否则每次生成两个文件，比较麻烦。
4.TOC_EXPAND 表示是否在索引中列举成员名称以及分组（譬如函数，枚举）名称。

八、运行doxygen

九、运行结束

软件特色

它可以从一组文档化的源文件生成一个在线文档浏览器（HTML）和/或离线参考手册（$ mbox { LaTeX} $）。 还支持在RTF（MS-Word），PostScript，超链接PDF，压缩HTML和Unix手册页中生成输出。 文档直接从源中提取，这使得保持文档与源代码一致更容易。
您可以配置doxygen从未记录的源文件中提取代码结构。 这对于在大型源代码中快速找到方法非常有用。 Doxygen还可以通过包括依赖关系图，继承图和协作图来可视化各种元素之间的关系，这些都是自动生成的。
您也可以使用doxygen创建正常的文档（就像我对doxygen用户手册和网站一样）。

如何使用

项目一般设置
首先在“Wizard”标签的Project项进行如下设置：
项目名称：将在最新的文档首页中显示
源码列表：选择要生成文档的源代码或目录，可以有多个文件或目录形成一个列表。建议使用相对路径，相对于当前目录（也即当前配置文件所在的目录）
递归扫描：如果需要对整个源码目录下的所有子目录及文件生成文档，请勾选本项
输出目录：设置最终生成的帮助文档的存储路径，建议使用相对路径
下一步，Mode项，根据需要设置文档生成模式。
下一步，Output项，设置输出格式，勾选HTML和“prepare for compressed HTML(.chm)”
然后切换到“Expert”标签的“HTML”项，设置HTML和CHM相关的选项：
GENERATE_HTMLHELP：确保已经勾选了
CHM_FILE：最终生成的.chm的文件名，如“HkcProjectHelp.chm”。默认为“index.chm”。可以使用路径，也可以使用相对路径，相对于上面设置的输出目录的html目录（建设使用上一级目录，如“..MyDoc.chm”）
HHC_LOCATION：chm 编译器（hhc.exe）的全路径。请指到 HTML Help Workshop 的安装目录的 hhc.exe 程序
CHM_INDEX_ENCODING：chm索引文件编码，下面会讲到，这里填“GBK”
编码设置
编码设置很重要，如果设置不当，生成的文档会出现乱码。因为 Doxygen 汲及的东西多，有好几项编码设置，所以需要认真对待，根据项目的实情情况设置。
所有高级设置（包括编码设置）都在“Expert”标签，重要的设置项如下：
Project/DOXYFILE_ENCODING：当前 Doxygen 配置文件本身的字符编码，默认为UTF-8，一般不需要修改
Project/OUTPUT_LANGUAGE：输出语言。这里是指Doxygen自己生成的导航、提示、帮助等文本的文字采用的语言。我们希望帮助文档是全中文的，所以选择Chinese
Input/INPUT_ENCODING：输入文件的编码。这里是指我们的源代码文件本身的编码。在Windows平台一般是系统编码（GBK），而Linux平台一般是UTF-8。请用文本编辑器查看源文件的编码。这里如果设置的不一致，源码文件的注释中所有非ASCII字符将在生成的文档中变成乱码。
HTMP/CHM_INDEX_ENCODING：这里设置Doxygen生成的CHM索引文件的编码，以前是不能设置的，默认为UTF-8，而微软的编译器不能识别UTF-8编码的索引文件，所以最终造成左边目录导航栏乱码。我们设置它为GBK，这样Doxygen将为我们生成GBK编码的索引文件（.hhc、.hhk、.hhp）
生成CHM文档
设置好了后，点击“Run”→“Run doxygen”生成最终的.chm文档，如果设置正确，打开后是全中文的了。