doxygen 1.8.5 中文使用指南:配置与输出设置

需积分: 13 12 下载量 164 浏览量 更新于2024-09-12 收藏 21.71MB DOC 举报
"这是一份关于doxygen 1.8.5版本的最新中文使用界面文档,涵盖了设置项目、选择输出模式以及不同输出格式的详细信息。" 在使用doxygen这款强大的源代码文档生成工具时,了解其界面及配置至关重要。以下是关于doxygen 1.8.5版中文文档的主要内容: 1. Wizard---Project(向导—项目) 在开始使用doxygen之前,你需要在"Project"部分设定工作目录,即源代码的位置。点击"Select"按钮选择源代码所在的目录。接着,你可以设置项目名称(Projectname),并指定源代码目录(Sourcecode directory)。选择"Scan recursively"将使doxygen递归扫描该目录下的所有源文件。同时,你还需要指定输出文档的位置。 2. Wizard---Mode(向导—模式) 在"Mode"部分,你可以选择文档生成的详细程度。"All Entities"模式将输出所有实体信息,包括函数、类、变量等。此外,根据个人需求,你可以在此选择输出源代码或仅输出文档。同时,这里还可以选择生成文档的语言。 3. Wizard---Output(向导—输出) - HTML输出:生成的HTML文档是默认的输出格式,可以通过HTML浏览器查看,例如Mozilla、Safari、Konqueror或IE6。为了充分利用doxygen的特性,如树状视图和搜索引擎,建议使用支持CSS和JavaScript的浏览器。主入口点是html目录中的index.html文件。 - Manpage输出:生成的man页面适用于man程序查看,但需要确保man目录位于MANPATH环境变量指定的路径下。然而,man格式有一些限制,可能导致部分信息(如类图表、交叉引用和公式)丢失。 - RTF输出:doxygen会将所有文档合并到一个名为refman.rtf的文件中,优化以供Microsoft Word使用。若要查看某些编码的实际值,可以选择全部并右键点击以触发域。 - XML输出:这是一种结构化的信息集合,每个单元(如类、命名空间或文件)都有单独的XML文件和一个index.xml索引文件。还提供了一个.xslt脚本,用于将所有XML文件合并成单个文件。同时,生成的XML图式文件(index.xsd和compound.xsd)用于描述存在的元素、属性及其结构,便于验证或控制XSLT脚本。 在"addon/doxmlparser"目录下,doxygen提供了一个解析库,可以读取和增量处理XML文件,这对于大型项目来说非常有用。 这份doxygen 1.8.5版的中文文档详尽地介绍了如何配置和使用这款工具,帮助开发者生成清晰、全面的源代码文档,无论是对于个人项目还是团队协作,都是非常有价值的参考资料。
2012-04-10 上传
Doxygen 中文使用文档 及 适合Doxygen的注释宏 使注释更简单 统一 注释宏 已经过修改 使用简单方便 Doxygen 是一个程序的文件产生工具,可将程序中的特定批注转换成为说明文件。通常我们在写程序时,或多或少都会写上批注,但是对于其它人而言,要直接探索程序里的批注,与打捞铁达尼号同样的辛苦。大部分有用的批注都是属于针对函式,类别等等的说明。所以,如果能依据程序本身的结构,将批注经过处理重新整理成为一个纯粹的参考手册,对于后面利用您的程序代码的人而言将会减少许多的负担。不过,反过来说,整理文件的工作对于您来说,就是沉重的负担。   对于未归档的源文件,也可以通过配置Doxygen来提取代码结构。或者借助自动生成的包含依赖图(includedependency graphs)、继承图(inheritance diagram)以及协作图(collaborationdiagram)来可视化文档之间的关系。Doxygen生成的帮助文档的格式可以是CHM、RTF、PostScript、PDF、HTML和Unixman page等。   一个好的程序设计师,在写程序时,都会在适当的地方加上合适的批注。如果,能够在撰写批注时,稍微符合某种格式,接着就可以透过一个工具程序依据程序结构及您的批注产生出漂亮的文件。这将令许多工作繁重的程序设计师有时间多喝几杯咖啡。   Doxygen 就是这样的一个工具。在您写批注时,稍微按照一些它所制订的规则。接着,他就可以帮您产生出漂亮的文件了。因此,Doxygen 的使用可分为两大部分。首先是特定格式的批注撰写,第二便是利用Doxygen的工具来产生文件。