简述

注释的原则是有助于对程序的阅读理解，不宜太多，也不能太少（一般情况下，源代码有效注释量必须在 20％ 以上），注释必须准确、易懂、简洁。

说明性文件（例如：.h 文件、.inc 文件、.def 文件等）头部应进行注释，注释一般需要列出：版权说明、版本号、生成日期、作者、内容、功能、与其它文件的关系、修改日志等，头文件的注释中还应有函数功能简要说明。

怎么在 Qt Creator 中自动补全注释呢？下面我们进行配置说明，简单的介绍自定义注释的添加（注释的风格可根据自己的喜好自定义）。

版权所有：一去丶二三里，转载请注明出处：http://blog.csdn.net/liang19890820

配置

打开 Qt Creator，菜单选择：工具 -> 选项 -> 文本编辑器 -> 段落。点击“添加”按钮，编辑自定义的“触发”。

例如，触发：“header”，触发种类：“custom”（也可以填写为其它内容）。然后填写注释的内容（也可以是其它形式的代码段），点击“确定”进行保存。

/**
* @brief 摘要
* @author 一去丶二三里
* @date 2017/02/08
*/

在编辑器中输入“header”，就会关联刚才设置的注释。

Ok，大功告成，注释模板就自动添加上去了。

建议：添加一些常用的注释模版，便于后期开发维护。。。PS：维护别人的代码真心伤不起呐！！！