Doxygen文档系统---入门

最新推荐文章于 2024-05-14 00:04:14 发布

原创

最新推荐文章于 2024-05-14 00:04:14 发布 · 413 阅读

0 ·

CC 4.0 BY-SA版权

Doxygen是一款开源的跨平台文档系统，支持多种编程语言，包括C、C++、Java等。它能从源代码中生成HTML、LATEX、RTF格式的文档。本文介绍了Doxygen的安装、运行及配置文件Doxyfile的修改，帮助初学者快速上手。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

Doxygen简介：Doxygen是一种开源跨平台的，以类似JavaDoc风格描述的文档系统，完全支持C、C++、Java、Objective-C和IDL语言，部分支持PHP、C#。注释的语法与Qt-Doc、KDoc和JavaDoc兼容。Doxygen可以从一套归档源文件开始，生成HTML格式的在线类浏览器，或离线的LATEX、RTF参考手册。

一. 安装

1. 下载二进制文件

./configure
make install

note:

make install_docs 安装文档和示例；
通过configue文件的-prefix改变安装路径。
2. 软件包安装

sudo apt install doxygen //版本低

3. 从源码编译

二. 运行

doxygen -s -g <config-file> //生成配置文件，config-file为配置文件，默认为Doxyfile. -s为省略配置文件的注释（一般不加）
doxygen <config-file> //执行配置文件，生成输出目录

三.配置文件Doxyfile(默认)修改
常见需要修改的一些配置：
PROJECT_NAME ：项目名称
PROJECT_NUMBER : 版本号
OUTPUT_DIRECTORY ：输出路径（默认为当前路径）
INLINE_INHERITED_MEMB ：是否显示类的继承成员
MULTILINE_CPP_IS_BRIEF ：允许使用C++注释块
OPTIMIZE_OU