前言
在使用QT时候经常需要对代码进行注释,这个时候如果每次都是手打注释太慢了,可以利用QT设置注释模板,自动生成函数的注释。注释的原则是有助于对程序的阅读理解,不宜太多,也不能太少(一般情况下,源代码有效注释量必须在 20% 以上)。注释的风格可根据自己的喜好自定义,但必须准确、简洁、易懂。
Qt Creator设置自动注释
1.打开Qt Creator,点击工具->选项。
2.选中文本编辑器,点击片段:
3.点击添加,在触发中输入“header”,在下面的输入框中粘贴如下内容:
/*!
* @file filename
* @brief 对于文件的简单注释
* @note 详细说明
*
* @version V1.00
* @date 2022/10/10
* @author 小明
* @copyright XXX有限公司
*/