doxygen是一款开源的文档生成工具,主要用于从源代码注释中自动生成项目文档。它最初为C++设计,但现已支持C、Java、Python、PHP、C#等多种编程语言。开发者在代码中按照Doxygen约定的格式编写注释(例如使用@param、@return等标签),Doxygen解析源代码和这些注释,生成结构化的技术文档。这大幅降低了维护文档与代码同步的负担。

【功能特色】
支持从代码中的特殊格式注释(如/** ... */)提取文档。
可生成多种输出格式,包括HTML、LaTeX、RTF、PDF、XML等。
自动生成类图、调用关系图、协作图等可视化图表(需安装Graphviz)。
支持跨平台(Windows、Linux、macOS)。
【应用场景】
生成API参考文档。
为开源或企业内部项目提供可浏览的在线文档。
辅助代码理解和团队协作。
【使用说明】
使用向导和/或专家选项卡配置doxygen,然后切换到运行选项卡生成文档

【标签说明】
OUTPUT_DIRECTORY
OUTPUT_DIRECTORY 标签用于指定生成文档的(相对或绝对)路径。如果输入相对路径,它将相对于 Doxygen 启动的位置。如果留空,则使用当前目录。
DOXYFILE_ENCODING
此标签指定配置文件中所有后续字符使用的编码。默认值为 UTF-8,这也是此标签首次出现之前所有文本使用的编码。Doxygen 使用 libiconv(或 libc 中内置的 iconv)进行转码。
PROJECT_NAME
PROJECT_NAME 标签是一个单词(除非使用 Doxywizard,否则为用双引号括起来的一系列单词),用于标识生成文档的项目。此名称用于大多数生成页面的标题和其他一些地方。
默认值为:My Project。
【注意事项】
1、注释格式要规范:
混用不同注释风格可能导致解析失败,建议统一使用一种风格(如JavaDoc或Doxygen自有风格)。
2、编码问题:
源文件编码建议设为UTF-8,避免中文乱码。若生成CHM,需设置CHM_INDEX_ENCODING = GB2312。
3、路径配置:
确保INPUT路径正确,若需递归扫描子目录,设置RECURSIVE = YES。
4、图表生成:
启用HAVE_DOT = YES并配置Graphviz路径,才能生成类图和调用图。
5、未注释代码处理:
新手可设EXTRACT_ALL = YES提取未注释代码,但建议逐步规范注释,最终设为NO。