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

需积分: 13 12 下载量 79 浏览量 更新于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版的中文文档详尽地介绍了如何配置和使用这款工具,帮助开发者生成清晰、全面的源代码文档,无论是对于个人项目还是团队协作,都是非常有价值的参考资料。