Question

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

/*!
    \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等。另外，我在源文件中使用哪些工具从这些注释中生成文档文件？ Doxygen是否支持这种语法？

Answer 1

不要使用qdoc。 It is deprecated。使用Doxygen，无论如何都是基于qdoc。

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

Answer 2

使用doxygen创建文档

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

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

http://www.doxygen.nl/

Answer 3

doxygen的两个部分是 qt-specific ： Qt Comment Style 和QT_AUTOBRIEF Doxyfile配置标记。这些只是QT使用的doxygen的一部分。 QT使用的所有doxygen评论都是常规的doxygen东西。所以你只需要阅读doxygen。

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

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

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

来自doygen GUI帮助：

QT_AUTOBRIEF标记设置为YES 然后doxygen会解释第一个 a的一行（直到第一个点） Qt式评论作为简报描述。如果设置为NO，则评论的行为就像常规一样 Qt风格的评论（因此需要一个用于简要说明的explicit \ brief命令说明。）

Answer 4

您可以查看Qt源代码本身以获取Qt文档注释...

Qt - SRC - 4.6.3

我使用 DOxygen 作为文档，对我来说它工作正常，但文档标准不是Qt。我建议你试一下，然后再决定。

Qt文档评论的文档？ Qt + Doxygen？

4 个答案: