工程师 - Doxygen介绍

Code Documentation.

Automated.

Free, open source, cross-platform.

Version 1.12.0 is now available! Release date: 7 August 2024

官方网址：

Doxygen homepage

文档：

Doxygen: Overview

Github网址：

https://github.com/doxygen/doxygen

下载并安装Windows 64bit版的安装文件doxygen-1.12.0-setup.exe。

Doxygen 是软件开发中广泛使用的文档生成工具。它能根据源代码注释自动生成文档，解析有关类、函数和变量的信息，生成 HTML 和 PDF 等格式的输出。通过简化和标准化文档流程，Doxygen 加强了不同编程语言和项目规模之间的协作和维护。

Doxygen is a widely-used documentation generator tool in software development. It automates the generation of documentation from source code comments, parsing information about classes, functions, and variables to produce output in formats like HTML and PDF. By simplifying and standardizing the documentation process, Doxygen enhances collaboration and maintenance across diverse programming languages and project scales.

Multiple output formats

Doxygen 可以生成各种输出格式的文档，如 HTML、PDF（通过 LaTeX）、Word（通过 RTF）和 XML。

这种灵活性允许开发人员选择最适合自己需要的格式，或将文档集成到不同的系统中。

Doxygen can generate documentation in various output formats, such as HTML, PDF (via LaTeX), Word (via RTF), and XML.

This flexibility allows developers to choose the format that best suits their needs or integrate the documentation into different systems.

Markdown

Doxygen 中的 Markdown 支持可以让您将 Markdown 的简洁性与 Doxygen 的强大功能相结合，用于描述代码。

除了 Markdown 之外，Doxygen 还支持许多命令，如 \param、\return、\brief 等，以提供有关函数、参数和返回值的附加信息。

Markdown support in Doxygen allows you to combine the simplicity of Markdown with the powerful features of Doxygen for documenting code.

Next to Markdown, Doxygen supports many commands like \param, \return, \brief, etc., to provide additional information about functions, parameters, and return values.

C++

Doxygen provides robust support for documenting C++ code, recognizing the intricacies of the language and generating comprehensive documentation.

Next to C++, Doxygen also supports C, Python, PHP, Java, C#, Objective-C, Fortran, VHDL, Splice, IDL, and Lex.

Cross-referencing

Doxygen 提供交叉引用功能，允许用户在文档的不同部分之间进行导航。

Doxygen 会生成指向相关元素的超链接，方便用户探索代码库并了解不同组件之间的关系。

Doxygen provides cross-referencing capabilities, allowing users to navigate between different parts of the documentation.

Doxygen generates hyperlinks to related elements, making it easy to explore the codebase and understand the relationships between different components.

Diagrams

Doxygen 可以生成图形化的类层次结构和协作图，为类和函数之间的关系提供可视化概览。

Doxygen can generate graphical representations of class hierarchies and collaboration diagrams, providing a visual overview of the relationships between classes and functions.

Configuration

Doxygen 提供一个配置文件（Doxyfile），允许用户自定义文档生成过程。您可以控制各种设置，如输出格式、文件包含/排除等。

Doxygen provides a configuration file (Doxyfile) that allows users to customize the documentation generation process. You can control various settings, such as the output format, file inclusion/exclusion, and more.

安装时显示的License LGPL-2.0：

GNU 库通用公共许可证 v2.0 - GNU 工程 - 自由软件基金会

                    GNU GENERAL PUBLIC LICENSE

                       Version 2, June 1991

Copyright (C) 1989, 1991 Free Software Foundation, Inc.,

51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA

Everyone is permitted to copy and distribute verbatim copies

of this license document, but changing it is not allowed.

                            Preamble

  The licenses for most software are designed to take away your

freedom to share and change it.  By contrast, the GNU General Public

License is intended to guarantee your freedom to share and change free

software--to make sure the software is free for all its users.  This

General Public License applies to most of the Free Software

Foundation's software and to any other program whose authors commit to

using it.  (Some other Free Software Foundation software is covered by

the GNU Lesser General Public License instead.)  You can apply it to

your programs, too.

  When we speak of free software, we are referring to freedom, not

price.  Our General Public Licenses are designed to make sure that you

have the freedom to distribute copies of free software (and charge for

this service if you wish), that you receive source code or can get it

if you want it, that you can change the software or use pieces of it

in new free programs; and that you know you can do these things.

  To protect your rights, we need to make restrictions that forbid

anyone to deny you these rights or to ask you to surrender the rights.

These restrictions translate to certain responsibilities for you if you

distribute copies of the software, or if you modify it.

  For example, if you distribute copies of such a program, whether

gratis or for a fee, you must give the recipients all the rights that

you have.  You must make sure that they, too, receive or can get the

source code.  And you must show them these terms so they know their

rights.

  We protect your rights with two steps: (1) copyright the software, and

(2) offer you this license which gives you legal permission to copy,

distribute and/or modify the software.

  Also, for each author's protection and ours, we want to make certain

that everyone understands that there is no warranty for this free

software.  If the software is modified by someone else and passed on, we

want its recipients to know that what they have is not the original, so

that any problems introduced by others will not reflect on the original

authors' reputations.

  Finally, any free program is threatened constantly by software

patents.  We wish to avoid the danger that redistributors of a free

program will individually obtain patent licenses, in effect making the

program proprietary.  To prevent this, we have made it clear that any

patent must be licensed for everyone's free use or not licensed at all.

  The precise terms and conditions for copying, distribution and

modification follow.