如何在QML调用时显示C++函数注释作为Qt编辑器的悬浮提示
可行操作方案
- 首先确认Qt Creator版本≥4.15,该版本开始原生支持C++暴露给QML的接口注释同步到QML悬浮提示。
- 保证C++侧的注释直接写在
Q_INVOKABLE函数声明上方,和函数声明之间无空行分隔。你当前使用的//!风格注释本身兼容识别,也可以替换为标准Doxygen格式提升兼容性:
/** * @brief This is my test function * @param q 第一个入参字符串 * @param b 第二个入参字符串 */ Q_INVOKABLE void test(QString q, QString b);
- 确保项目中QML类型注册逻辑正确:
- 手动调用
qmlRegisterType注册的类需要保证注册逻辑可被Qt Creator的代码模型扫描到 - 优先使用Qt 5.15+提供的
QML_ELEMENT宏完成QML类型注册,对注释同步的适配更完善
- 手动调用
- 触发代码重新索引:清除项目编译产物后重新执行qmake/CMake,按下
Ctrl+Shift+R(Windows/Linux)或Cmd+Shift+R(Mac)强制Qt Creator重新扫描项目代码,偶发索引失效时重启Qt Creator即可恢复。
内容的提问来源于stack exchange,提问作者Chilarai
相关产品推荐
相关产品推荐

