Qt中给代码注释的方法

1、背景

C++，希望鼠标指向对象或变量时，悬浮框可以显示写的注释。

2、实现方法

1）对于函数

在头文件.h的函数声明之上输入/**，再按回车，Qt就会自动显示函数注释和参数注释，例如：

        /**
         * @brief on_pushButton_Setting_clicked
         */
        void on_pushButton_Setting_clicked();

        /**
       * @brief plot received data
       * 绘图
       * @param data：获取到的数据
       */
        void on_receivePlot(QVector data);

在任何地方调用这个函数时，只需要将鼠标停留在这个函数名称，Qt就会显示悬浮框，提示函数用法，例如：

注：如果不是在头文件注释，而是在定义函数前注释（例如，在.cpp文件定义函数时注释），则在其他文件处看不到注释内容。另外，注释应当在函数声明前而不是在函数定义内注释。

2）对变量的注释

直接在函数定义后面打“//”注释即可，例如：

int g_lost = 0;// 丢失包个数

悬浮框如下：