【Qt】添加自定义注释

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

那么，如何在 Qt Creator 中自动补全注释呢？

基本配置

打开 Qt Creator，菜单选择：Tools -> Options -> Text Editor -> Snippets。点击“Add”按钮，编辑自定义的“Trigger”。

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

/*------------------------------------------------------------------------
函数原型:
功能描述:
输入参数:
输出参数:
返 回 值:
注意事项:
------------------------------------------------------------------------*/

点击“OK”进行保存：

简单使用

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

然后按“回车”，注释模板就自动添加上去了：

建议：添加一些常用的注释模版，便于后期开发维护。