QDoc 入门

Qt 使用 QDoc 将其文档集生成 HTML 和 DocBook XML 格式。QDoc 使用一组配置文件从 QDoc 注释中生成文档。注释的类型称为主题,它决定了注释是类文档还是属性文档。注释还可能带有标记,以增强最终输出的布局和格式。

使用 QDoc 生成文档有三种基本材料:

  • QDoc 二进制文件
  • qdocconf 配置文件
  • Documentation 在 、 和 文件中。C++ QML .qdoc

注意: QDoc需要Clang来解析 C++ 头文件和源文件,以及解析\fn命令中的函数签名。详情请参阅为 QDoc 安装 Clang

本节旨在介绍创建文档集的基本要素。此外,本指南还将介绍编写非 C++ API 文档和 QML 文档的特殊注意事项和选项。最后,本指南将提供一个项目文档示例和一个 QML 类型文档示例。

有关 QDoc 的具体信息,请查阅《QDoc 手册》。

章节

  1. 为 QDoc 安装 Clang
  2. 创建 QDoc 配置文件
  3. 编写文档
  4. 文档类别
  5. 如何解决 QDoc 警告

© 2025 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.