分类
大小:24.5M更新:2015-01-06
类别:编程辅助系统:WinAll,WinXP
Doxygen已经支持生成ANSI编码的chm目录文件(index.hhc)!Doxygen通常是用作生成英文文档的,生成中文文档需要修改输入和输出的码制,这样可以改变解析方式,生成中文文档。但是,你必须意识 到,Doxygen在从注释中抽取信息是需要做语法解析的,这些解析都是基于英文的基础,不可能在这个层面上支持中文。
Doxygen 是一个 C++, C, Java, Objective-C、Python、IDL (CORBA 和 Microsoft flavors)、Fortran、VHDL、PHP、C#和D语言的文档生成器。可以运行在大多数类Unix系统,以及Mac OS X操作系统和Microsoft Windows 。 初始版本的Doxygen借鉴了一些老版本DOC++的代码;随后,Doxygen源代码由Dimitri van Heesch重写。
Doxygen是一个编写软件参考文档的工具。 该文档是直接写在代码中,因此比较容易保持更新。 Doxygen 可以交叉引用文档和代码,使文件的读者可以很容易地引用实际的代码。Doxygen的开发作为方便和访问文件系统的C,C,Java中的Objective-C,Python中,IDL,并在一定程度上的PHP,C#和D。
Doxygen 1.8.4 改进了跨引用、语法高亮和通过 LLVM/clang 解析源码来获取调用图表的特性,支持 DocBook 输出和解析 UNO IDL 文件,此外还包含一些小改动和提升以及 bug 修复。
下载和安装 Doxygen
下载最新的Doxygen安装程序,然后安装。这个软件包包括了一个GUI界面的前端工具,可以帮助我们方便创建Doxygen配置文件和生成目标文档。
下载和安装 chm 编译器
我们使用微软古老的 HTML Help Workshop 1.3,这个软件N久没更新了。
下载后根据提示安装。
项目一般设置
首先在“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文档,如果设置正确,打开后是全中文的了。
mysql数据库.net开发驱动(mysql connector net )编程辅助M8.0.11 官方最新版
查看IIS 8.0 EXPRESS编程辅助M官方中文版
查看XINS编程辅助MV2.3 英文免费版
查看Api开发测试工具RunApi编程辅助Mv1.0.0 官方版
查看亿图图示专家2019编程辅助MV9.3 特别版
查看java流程分析插件(SOPA)编程辅助M1.1.9 免费版
查看EM773开发驱动包编程辅助MV1.1官方版
查看httppost\get调试工具(postman)编程辅助M4.1.3 官方版
查看Python for windows编程辅助Mv3.6.5 安装版
查看大XML文档快速阅读工具Quick XML Reader编程辅助.22M1.1.5.0 绿色版
查看代码编辑器(CodeLobster PHP Edition)编程辅助Mv5.14.3中文版
查看Visual Assist X编程辅助MV10.9.2223 官方原版
查看CHM Editor单文件绿化版编程辅助MV3.12.418免费版
查看易语言资源助手最新版编程辅助M绿色版
查看CodeSmith Professional编程辅助MV4.1.4 英文绿色版
查看RegexBuddy去广告永不过期版编程辅助MV4.9免费安装版
查看山外多功能调试助手编程辅助Mv1.1.1 绿色版
查看jar包修复工具箱编程辅助.03Mv1.2.0
查看传华mp3文件剪切器编程辅助.08MV2.35.6绿色免费版
查看ReSharper编程辅助Mv183.0.5217.10118 官方最新版
查看虚拟示波器编程辅助.17M2.9.3 中文免费版
查看.NET Framework环境框架下载器编程辅助M最新版
查看亿联网络协议头及数据格式处理编程辅助MV1.0免费版
查看SoapUI For Linux编程辅助MV5.2.1免费版
查看点击查看更多