0

0

如何为c++项目创建一个符合规范的Doxyfile? (Doxygen文档生成)

裘德小鎮的故事

裘德小鎮的故事

发布时间:2026-01-14 15:18:10

|

994人浏览过

|

来源于php中文网

原创

Doxyfile 是 doxygen -g 生成的模板配置文件,不应手写全量;必须修改 PROJECT_NAME、INPUT 等基础项,并启用 ENABLE_PREPROCESSING、EXTRACT_PRIVATE 等关键开关以支持 C++ 特性与符号可见性。

如何为c++项目创建一个符合规范的doxyfile? (doxygen文档生成)

Doxyfile 是什么,为什么不能手写全量配置

Doxyfile 不是必须从零手写的配置文件,而是 doxygen -g 生成的模板。手动拼凑所有选项极易遗漏关键开关(比如 EXTRACT_ALL 关闭时私有成员默认不文档化),导致生成内容为空或不符合预期。官方推荐流程永远是先生成再按需修改。

用 doxygen -g 生成基础 Doxyfile 并设置项目元信息

在项目根目录执行:

doxygen -g Doxyfile
会生成一个完整但注释掉大部分选项的配置文件。接下来必须修改以下几项,否则文档首页无标识、路径解析错误或无法识别 C++17 特性:

  • PROJECT_NAME = "MyCppLib" —— 必须填,空值会导致首页标题异常
  • PROJECT_NUMBER = "1.2.0" —— 建议填,影响版本页展示
  • INPUT = ./src ./include —— 显式列出头文件与实现路径,不要依赖递归(RECURSIVE = YES 有性能开销且易误扫构建目录)
  • FILE_PATTERNS = *.h *.hpp *.cpp *.cc *.cxx —— 明确扩展名,避免漏掉 .hpp.cc
  • EXTENSION_MAPPING = "hpp=C++" "hxx=C++" —— 确保 Doxygen 正确解析现代 C++ 头文件语法

启用 C++ 特性支持与符号可见性控制

默认 Doxyfile 对模板、constexpr、concept、模块(C++20)等支持不足,且会跳过 private 成员。常见错误是只改了 EXTRACT_PRIVATE = YES 却忘了同步打开 EXTRACT_STATIC = YES(否则静态成员不出现)和 EXTRACT_LOCAL_METHODS = YES(否则 lambda 内部函数丢失):

  • EXTRACT_ALL = NO —— 生产环境建议设为 NO,靠 EXTRACT_PRIVATE/EXTRACT_STATIC 精细控制
  • ENABLE_PREPROCESSING = YES —— 必须开启,否则宏定义、#ifdef 区块无法正确展开
  • MACRO_EXPANSION = YESEXPAND_ONLY_PREDEF = YES —— 配合使用,避免展开全部宏导致文档臃肿
  • PREDEFINED = "DOXYGEN_SHOULD_SKIP_THIS" "Q_DECL_EXPORT=" —— 把构建系统中干扰解析的宏显式“清空”,例如 Qt 的导出宏

输出格式、搜索与跨引用的关键开关

只生成 HTML 是最常见需求,但若关闭 GENERATE_TREEVIEW = YES,类继承图将不可折叠;若未设 SEARCHENGINE = YES,网页端搜索框实际不可用(即使 UI 显示)。容易被忽略的是跨模块引用问题:

来福FM
来福FM

来福 - 你的私人AI电台

下载

立即学习C++免费学习笔记(深入)”;

  • GENERATE_HTML = YESHTML_OUTPUT = html_doc —— 输出路径别用 docs/ 这类通用名,防止和 CI 脚本冲突
  • GENERATE_LATEX = NO —— 关闭 LaTeX 可显著加快生成速度,除非真要 PDF
  • USE_MDFILE_AS_MAINPAGE = README.md —— 若项目有 README.md,这行能让它成为首页,比手写 mainpage.md 更省事
  • ALIASES = "rst=\\xrefitem rst \"RST\" \"RST Rules\"" —— 如需自定义标签(如标记线程安全),用 ALIASES 而非硬编码 \xrefitem

复杂点在于:Doxygen 对模板特化、ADL、SFINAE 的解析仍有限,即使配置全开,部分重载或约束失败的函数也可能不显示。这时候得靠 @cond/@endcond 手动包裹,或在代码中加 /// @brief ... 强制暴露。

相关文章

c++速学教程(入门到精通)
c++速学教程(入门到精通)

c++怎么学习?c++怎么入门?c++在哪学?c++怎么学才快?不用担心,这里为大家提供了c++速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
视频后缀名都有哪些
视频后缀名都有哪些

视频后缀名都有avi、mpg、mpeg、rm、rmvb、flv、wmv、mov、mkv、ASF、M1V、M2V、MPE、QT、VOB、RA、RMJ、RMS、RAM、等等。更多关于视频后缀名的相关知识,详情请看本专题下面的文章,php中文网欢迎大家前来学习。

3426

2023.10.31

C++ Qt图形开发
C++ Qt图形开发

本专题专注于 C++ Qt框架在图形界面开发中的应用,系统讲解窗口设计、信号与槽机制、界面布局、事件处理、数据库连接与跨平台打包等核心技能,通过多个桌面应用项目实战,帮助学员快速掌握 Qt 框架并独立完成跨平台GUI软件的开发。

68

2025.08.15

C++ 图形界面开发基础(Qt方向)
C++ 图形界面开发基础(Qt方向)

本专题系统讲解 使用 C++ 与 Qt 进行图形界面(GUI)开发的核心技能,内容涵盖 Qt 项目结构、窗口组件、信号与槽机制、事件处理、布局管理、资源管理,以及跨平台编译与打包流程。通过多个小型桌面应用实战案例,帮助学习者掌握从界面设计到功能实现的完整 GUI 开发能力。

53

2025.12.05

html版权符号
html版权符号

html版权符号是“©”,可以在html源文件中直接输入或者从word中复制粘贴过来,php中文网还为大家带来html的相关下载资源、相关课程以及相关文章等内容,供大家免费下载使用。

606

2023.06.14

html在线编辑器
html在线编辑器

html在线编辑器是用于在线编辑的工具,编辑的内容是基于HTML的文档。它经常被应用于留言板留言、论坛发贴、Blog编写日志或等需要用户输入普通HTML的地方,是Web应用的常用模块之一。php中文网为大家带来了html在线编辑器的相关教程、以及相关文章等内容,供大家免费下载使用。

646

2023.06.21

html网页制作
html网页制作

html网页制作是指使用超文本标记语言来设计和创建网页的过程,html是一种标记语言,它使用标记来描述文档结构和语义,并定义了网页中的各种元素和内容的呈现方式。本专题为大家提供html网页制作的相关的文章、下载、课程内容,供大家免费下载体验。

466

2023.07.31

html空格
html空格

html空格是一种用于在网页中添加间隔和对齐文本的特殊字符,被用于在网页中插入额外的空间,以改变元素之间的排列和对齐方式。本专题为大家提供html空格的相关的文章、下载、课程内容,供大家免费下载体验。

245

2023.08.01

html是什么
html是什么

HTML是一种标准标记语言,用于创建和呈现网页的结构和内容,是互联网发展的基石,为网页开发提供了丰富的功能和灵活性。本专题为大家提供html相关的各种文章、以及下载和课程。

2885

2023.08.11

Java 桌面应用开发(JavaFX 实战)
Java 桌面应用开发(JavaFX 实战)

本专题系统讲解 Java 在桌面应用开发领域的实战应用,重点围绕 JavaFX 框架,涵盖界面布局、控件使用、事件处理、FXML、样式美化(CSS)、多线程与UI响应优化,以及桌面应用的打包与发布。通过完整示例项目,帮助学习者掌握 使用 Java 构建现代化、跨平台桌面应用程序的核心能力。

6

2026.01.14

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Bootstrap 5教程
Bootstrap 5教程

共46课时 | 2.9万人学习

AngularJS教程
AngularJS教程

共24课时 | 2.6万人学习

CSS教程
CSS教程

共754课时 | 18.9万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号