以往对变量写注释无非是在变量声明之后加上“//”跟着写注释,但是到了用Qt Creator 虽然可以这样写,但是到了引用该变量时,想显示变量的注释却无法显示出来,在网上找了很久都没有找到相关的。最后自己摸索出来关于变量注释的正确写法。
在Qt Creator 变量名注释的正确写法:
ULONG ulVersion; ///< mcu版本
QString binFileName; /< link.bin存放位置*/
使用 ///< 加注释内容 用于单行
多行的使用:
/< 注释内容 */
以下是分别用 ///< 和 /**< */对变量进行注释的例子截图。
注意的是使用//进行注释的写法,如果在vs studio上是可以正常显示注释内容的。