24

I was using Qt Creator and I decided I wanted to document a function I had written so I positioned my cursor above my function definition and typed /**<ENTER> like so:

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

Qt Creator auto-expanded that comment:

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

What is this? Where is it documented?

Can I use this to generate my own Qt Assistant qch help files or something?

4

1 回答 1

34

它应该记录在这里或这里，但它不是......

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

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

视窗：

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

Mac OS X：

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

它列出的三个选项是：

  • 启用 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

希望有帮助。

于 2013-07-30T19:55:41.950 回答