【转载】Qt Creator 添加自定义注释

时间:2023-03-08 17:48:00
【转载】Qt Creator 添加自定义注释

原文:https://blog.csdn.net/liang19890820/article/details/54925434

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

说明性文件(例如:.h 文件、.inc 文件、.def 文件等)头部应进行注释,注释一般需要列出:

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

那么,如何在 Qt Creator 中自动补全注释呢?

| 版权声明:一去、二三里,未经博主允许不得转载。

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

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

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

点击“OK”进行保存:

简单使用
在编辑器中输入“header”,就会关联刚才设置的注释:

这时候,注释模板就自动添加上去了:

Ok,大功告成。

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