logo标签列表

Qt文档注释的文档？Qt+Doxygen？

c++qtdocumentationdoxygennokia
8

我在哪里可以找到关于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支持这种语法吗？

您好，以上内容的意思是：作者想知道在编写代码时如何使用注释来生成文档，并希望了解与此相关的所有开关信息。请问是否可以提供相关信息？

4个回答
9
不要使用qdoc。它已被弃用。使用Doxygen，它基于qdoc。
话虽如此，文档（以qdoc格式 :-D）在这里。
1
我在寻找http://qt.gitorious.org/qt/pages/DocManual和http://qt.gitorious.org/qt/pages/DocMarkupCommands，不知道它叫什么（qdoc，呃？）所以我无法通过谷歌搜索得到。然而，很多链接似乎已经失效了。 - Jake Petroules
2
现在，您是说 qdoc 工具已被弃用，还是整个 qdoc 语法（包括工具）都已被弃用？诺基亚在 Qt 中专门使用 qdoc 语法，这只是为了向后兼容性，还是应该改用不同的样式（如 Javadoc 注释）？显然这取决于程序员，但我想保持与 Qt 或诺基亚推荐的其他内容一致。 - Jake Petroules
谢谢提供这些信息，这让我节省了很多时间。我原本打算使用qdoc3...真是个傻瓜！ - karlphillip
你确定 Qt 文档已经（仍然）被废弃了吗？你提供的链接已经失效了，在当前的 Qt 版本中有一个 qdoc 文档。 (https://qt-project.org/doc/qt-5.1/qdoc/01-qdoc-manual.html) - Random Citizen
1
答案涉及Qt <= 4.8，因为Qt 5于2012年发布。链接现在指向所需内容。 关于Qt 5.x，qdoc3已更名为qdoc。长话短说，它可以用于文档编写，但是由于它是为了满足Qt文档需求而开发的，因此它可能会在不同版本之间发生不兼容性变化，并且可能需要进行一些工作才能使其正常运行。更长的故事可以在这里阅读。 - BaCaRoZzo
3
有两个doxygen的部分是“qt-specific”的：Qt注释样式和QT_AUTOBRIEF Doxyfile配置标签。这些只是QT使用的doxygen的一部分。QT使用的所有doxygen注释都是常规的doxygen内容。因此，您只需要阅读有关doxygen的文档。
或者，您真的在寻找有关QT内部的文档，例如包含在this blog entry中的有关d-Pointers的信息。
Qt风格注释： /*! text */注释样式称为doxygen注释的“Qt Style”。！将整个注释块标记为doxygen注释块。它是doxygen的标准可选部分。
QT_AUTOBRIEF设置： 如果Doxyfile中的“QT_AUTOBRIEF”标签设置为TRUE，则Qt样式注释块的第一行会自动解释为\brief描述。
来自doygen GUI帮助的信息：
如果设置了QT_AUTOBRIEF标签为YES，则doxygen将把Qt风格注释的第一行（直到第一个句号）解释为简要描述。如果设置为NO，则注释将像普通的Qt风格注释一样（因此需要使用\ brief命令进行简要描述）。
1

使用Doxygen创建文档

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

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

http://www.doxygen.nl/

0

您可以查看Qt源代码本身以获取有关Qt文档注释的信息...

Qt - SRC - 4.6.3

我使用了DOxygen进行文档编写，对我而言它运作良好，虽然与Qt的标准不同。建议您尝试一下并做出决定。

网页内容由stack overflow 提供, 点击上面的
可以查看英文原文，
原文链接