doxygen/doxygen

GitHub: doxygen/doxygen

Doxygen 是一款广泛使用的源代码文档生成工具,通过解析带注释的源码自动生成多种格式的技术文档和代码结构可视化图表。

Stars: 6505 | Forks: 1354

# Doxygen Doxygen 是从带注释的 C++ 源代码生成文档的事实标准工具,但它也支持其他流行的编程语言,例如 C、Objective-C、C#、PHP、Java、Python、IDL(包括 Corba、Microsoft 和 UNO/OpenOffice 版本)、Fortran,在某种程度上也支持 D。Doxygen 还支持硬件描述语言 VHDL。 Doxygen 可以通过以下三种方式为您提供帮助: 1. 它可以从一组已文档化的源文件生成在线文档浏览器(HTML 格式)和/或离线参考手册(LaTeX 格式)。它还支持生成 RTF(MS-Word)、PostScript、带超链接的 PDF、压缩 HTML、DocBook 和 Unix man 页面格式的输出。文档是直接从源代码中提取的,这使得保持文档与源代码的一致性变得容易得多。 2. 您可以配置 Doxygen 从未文档化的源文件中提取代码结构。这对于在大型源代码库中快速找到您的方式非常有用。Doxygen 还可以通过 include 依赖关系图、继承图和协作图来可视化各个元素之间的关系,这些图表都是自动生成的。 3. 您还可以使用 Doxygen 创建常规文档(就像我为 Doxygen 用户手册和 Doxygen 网站所做的那样)。 ## 下载 最新的二进制文件和 Doxygen 源代码可以从以下地址下载: * https://www.doxygen.nl/ ## 开发者 * Linux、Windows 和 MacOS 构建状态:Github Actions Build Status * Coverity Scan 构建状态: Coverity Scan Build Status * Doxygen 的内部源代码文档 * 安装:请阅读手册的安装部分 (https://www.doxygen.nl/manual/install.html) * 项目统计:https://www.openhub.net/p/doxygen ## 问题、Bug、请求、想法 使用 [issue](https://github.com/doxygen/doxygen/issues) 跟踪器来报告 Bug。 ## 交流 ### 邮件列表 共有三个邮件列表: * doxygen-announce@lists.sourceforge.net - 仅用于发布新版本公告 * doxygen-users@lists.sourceforge.net - 面向 Doxygen 用户 * doxygen-develop@lists.sourceforge.net - 面向 Doxygen 开发者 * 要订阅,请访问以下链接 * https://sourceforge.net/projects/doxygen/ ## 源代码 2013 年 5 月,Doxygen 从 subversion 迁移到了托管在 GitHub 上的 git * https://github.com/doxygen/doxygen 祝您使用愉快, Dimitri van Heesch (doxygen at gmail.com)
标签:API文档, Bash脚本, C++, IPv6支持, SOC Prime, 代码分析, 凭证管理, 开发工具, 数据擦除, 文档生成, 逆向工具