Qt Creator 添加自定义注释

一去丶二三里

已于 2023-07-05 19:57:46 修改

阅读量3.3w

点赞数 32

分类专栏： Qt 实战一二三文章标签： Qt Qt-Creator Qt添加注释 Qt注释 Qt自定义注释

于 2017-02-08 13:19:19 首次发布

本文链接：https://blog.csdn.net/liang19890820/article/details/54925434

版权

144 篇文章 3396 订阅

订阅专栏

作者： 一去、二三里
个人微信号： iwaleon
微信公众号： 高效程序员

自定义注释

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

说明性文件（例如：.h 文件、.inc 文件、.def 文件等）头部应进行注释，注释一般需要列出：

此外，也可以列出与其它文件的关系、修改日志等，头文件的注释中还应有函数功能简要说明。

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

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

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

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

点击“OK”进行保存：

这里写图片描述

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

这里写图片描述

这时候，注释模板就自动添加上去了：

这里写图片描述

Ok，大功告成。

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