Qt 文档注释的文档？ Qt + Doxygen？ [关闭]答案

【问题标题】：Documentation for Qt documentation comments? Qt + Doxygen? [closed]Qt 文档注释的文档？ Qt + Doxygen？ [关闭]
【发布时间】：2011-03-04 19:04:31
【问题描述】：

在哪里可以找到 Qt 文档 cmets 的文档？我指的是 Qt 如何为文档 cmets 使用特定样式，如下所示：

/*!
    \class MyClassName
    \brief The MyClassName class is used as an example on Stack Overflow.

    This class serves a few functions, the most important being:

    \list
        \i So people can understand my question.
        \i So people can have a few laughs at the comedy in my example.
    \endlist
 */

...你明白了。那么在哪里可以找到有关所有开关的信息，例如 \class、\list、\brief 等。此外，我使用什么工具从源文件中的这些 cmets 生成文档文件？ Doxygen 是否支持这种语法？

【问题讨论】：

标签： c++ qt documentation doxygen nokia

【解决方案1】：

不要使用 qdoc。 It is deprecated。使用基于 qdoc 的 Doxygen。

也就是说，文档（qdoc 格式 :-D ）是here。

【讨论】：

我在寻找 qt.gitorious.org/qt/pages/DocManual 和 qt.gitorious.org/qt/pages/DocMarkupCommands。在不知道它叫什么的情况下（qdoc，嗯？）我无法谷歌它。很多链接似乎已经死了
现在，您是说 qdoc tool 已弃用，还是整个 qdoc syntax（包括该工具）已弃用？诺基亚仅在 Qt 中使用 qdoc 语法，这只是为了向后兼容还是应该使用不同的样式（如 Javadoc cmets）来代替？显然这取决于程序员，但我希望与 Qt 的其余部分或诺基亚推荐的任何内容保持一致。
感谢您提供的信息，这为我节省了很多时间。我本来打算 qdoc3 ...傻瓜！
你确定 Qt 文档（仍然）被弃用了吗？您提供的链接已失效，并且有一个qdoc documentation in the current qt version。
自 Qt 5 于 2012 年发布以来，答案针对 Qt 可以用于文档但是由于它是为了满足 Qt 文档需求而开发的，它可以从一个版本不兼容地更改为另一个版本，因此可能需要做一些工作来保持它运行。 Longer story can be read here.

【解决方案2】：

doxygen 有两部分是qt-specific：Qt 注释样式 和 QT_AUTOBRIEF Doxyfile 配置标签。这些只是 QT 使用的 doxygen 的一部分。 QT 使用的所有 doxygen cmets 都是常规的 doxygen 东西。所以你只需要阅读 doxygen。

或者您是否真的在寻找 QT 内部的文档，例如 this blog entry 中包含的关于 d-Pointers 的信息

Qt 风格评论： /*! text */ 评论风格被称为 doxygen cmets 的“Qt风格”。 ! 将整个注释块标记为 doxygen 注释块。它是 doxygen 的标准可选部分。

QT_AUTOBRIEF 设置： 如果“QT_AUTOBRIEF”标签在 Doxyfile 中设置为 TRUE，Qt 样式注释块的第一行将自动解释为 \brief 描述。

来自 doygen GUI 帮助：

QT_AUTOBRIEF 标签设置为 YES 然后 doxygen 将解释第一个 a 的线（直到第一个点） Qt 风格的注释作为概要描述。如果设置为 NO，则 cmets 的行为就像普通的一样 Qt 风格的 cmets（因此需要一个明确的 \brief 命令简要描述。）

【讨论】：

【解决方案3】：

使用 doxygen 创建文档

它可以从一组记录的源文件生成在线文档浏览器（HTML）和/或离线参考手册（LaTeX）。还支持在 RTF (MS-Word)、PostScript、超链接 PDF、压缩 HTML 和 Unix 手册页中生成输出。文档直接从源代码中提取，这使得文档与源代码保持一致变得更加容易。

您可以配置 doxygen 以从未记录的源文件中提取代码结构。这对于在大型源代码分发中快速找到您的方式非常有用。您还可以通过包含依赖图、继承图和协作图来可视化各种元素之间的关系，这些都是自动生成的。

http://www.doxygen.nl/

【讨论】：

【解决方案4】：

您可以查看 Qt 文档 cmets 的 Qt 源代码本身...

Qt - SRC - 4.6.3

我已将 DOxygen 用于文档，对我来说它工作正常，尽管文档标准不是 Qt。我建议你试一试，然后再决定。

【讨论】：