c++ - 在 Qt Creator 中使用我自己的函数的自动文档？

Question

我正在使用 Qt Creator，我决定要记录我编写的函数，因此我将光标放在函数定义上方并键入 /**<ENTER>像这样:

/**<ENTER>
void MyClass::myFunction(int myArg)
{
...

Qt Creator 自动扩展了该评论:

/**
 * @brief MyClass::myFunction
 * @param myArg
 */
void MyClass::myFunction(int myArg)
{
...

这是什么？它记录在哪里？

我可以用它来生成我自己的 Qt 助手吗qch帮助文件什么的？

Answer 1

应该记录在案 here或 here ，但不是……

所以这里有一些关于它的信息:

此功能的设置可在此处找到:

Windows:

Qt Creator > 工具 > 选项 > 文本编辑器 > 完成 > 文档注释

Mac OS X:

Qt Creator > Preferences > Text Editor > Completion > Documentation Comments

它列出的三个选项是:

• 启用 doxygen block
• 生成简要说明
• 添加前导星号

(在 Qt 2.6 中找到，但也可能在早期版本中？或者它可能是某个时候默认插件集的一部分。)

创建的 stub 是 doxygen 样式的 stub 。

您可以使用 doxygen 运行您的源代码并创建一些精美的文档，包括 chm 文件和 html 文档和 pdf。

http://www.doxygen.nl/

http://www.doxygen.nl/manual/output.html (包括 qch 文件)

这是一个Qt Creator的相关插件:

http://dev.kofee.org/projects/qtcreator-doxygen/wiki

并在您自己的程序中使用 QHelpEngine...

http://qt-project.org/doc/qt-4.8/qthelp-framework.html

最后，您可以使用 QDesktopServices 来处理帮助样式的 url:

http://doc-snapshot.qt-project.org/4.8/qdesktopservices.html#url-handlers

希望对您有所帮助。