Qt Creator自动给函数生成注释模板

---

前言

在使用QT时候经常需要对代码进行注释，这个时候如果每次都是手打注释太慢了，可以利用QT设置注释模板，自动生成函数的注释。注释的原则是有助于对程序的阅读理解，不宜太多，也不能太少（一般情况下，源代码有效注释量必须在 20％ 以上）。注释的风格可根据自己的喜好自定义，但必须准确、简洁、易懂。

---

提示：以下是本篇文章正文内容，下面案例可供参考

使用步骤

1.基本配置

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

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

/**********************************************
* @projectName   %{CurrentProject:Name} 
* @brief         摘要 
* @param         void
* @return        void
* @author        ZYH
* @date          %{CurrentDate:yyyy-MM-dd} 
**********************************************/

2.基本使用

在编辑器中输入“header”，就会关联刚才设置的注释，如下（示例）：

按下回车之后就可以自动生成如下的代码片段。