使用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 Assistant qch帮助文件吗？

Answer 1

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

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

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

视窗:

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

Mac OS X:

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

它列出的三个选项是:

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

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

您可以使用doxygen来运行源代码并在chm文件和html文档以及pdf中创建一些精美的文档.

这是Qt Creator的相关插件:

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

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

希望有所帮助.

你知道,Qt文档通常令人惊讶,但是有这样的边缘情况(并使用样式表,对我来说)我不知道如何找到一个功能的正确文档,如果它存在的话.感谢您提供详细信息. (3认同)