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

标签 c++ qt documentation qt-creator

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

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

Qt Creator 自动扩展了该评论:

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

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

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

最佳答案

应该记录在案 herehere ,但不是……

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

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

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

希望对您有所帮助。

关于c++ - 在 Qt Creator 中使用我自己的函数的自动文档?,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/17955686/

相关文章:

c++ - 得到一个类的两个实例?

python - Pyside 改变 QIcon 中 SVG 的颜色或不透明度

c++ - 保存json文件后如何返回文件路径?

autocomplete - 如何在 DocBlock 中声明无限/可变参数?

documentation - 发行说明,有什么用?

c++ - 无效使用非静态数据成员 'linkedList<int>::dummyNode' c++

c# - 一个解决方案中的非托管 DLL 项目和托管 WinForms 应用程序

c++ - QList 如何决定是存储指针还是存储项目本身?

qt - 在 Qt 应用程序中使用 WinAPI 提取图标

python - 如何将 Python 文件文档字符串转换为 HTML