使用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，但不是......

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

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

<强>窗：

Qt Creator＆gt;工具＆gt;选项＆gt;文本编辑器＆gt;完成＆gt;文档评论

Mac OS X：

Qt Creator＆gt;偏好＆gt;文本编辑器＆gt;完成＆gt;文档评论

它列出的三个选项是：

• 启用doxygen块
• 生成简要说明
• 添加主要星号

（在Qt 2.6中找到，但也可能在早期版本中？，或者它可能是默认插件集的一部分。）

创建的存根是doxygen样式存根。

您可以使用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

希望有所帮助。