【转载】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，大功告成。

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

转载于:https://www.cnblogs.com/h2zZhou/p/10172772.html

【转载】Qt Creator 添加自定义注释相关推荐

Qt Creator 添加自定义注释
Qt Creator 添加自定义注释自定义注释注释的原则是有助于对程序的阅读理解,不宜太多,也不能太少(一般情况下,源代码有效注释量必须在20%以上).注释的风格可根据自己的喜好自定义,但必须准确 ...
Qt Creator 注释乱码
注释乱码今天把vs2013+qt 下编辑的项目转换成Qt Creator 项目.转换后打开发现注释都变成了乱码.并且cpp文件也不能编辑了. 网上查了几个教程也没好使,大体都是说编码格式的原因,自己 ...
qt creator插入代码块快速注释snippets代码片段的功能
定义任何开发IDE中,一般都提供snippets代码片段的功能,就是为了方便快捷的插入格式一致的代码段或者注释段. 步骤 qt creator 添加头文件,源文件的注释功能. 在qt creator ...
Qt creator一些常用的快捷注释语句
经常使用qt creator,一些频繁使用的注释总结一下: todo list: //TODO $$ %{CurrentDate:yyyy-MM-dd} //NOTE $$ %{CurrentDate ...
转载：Qt Creator的CDB调试器--使用技巧与心得，重点是Symbols Path设置
Qt Creator的CDB调试器--使用技巧与解决调试很慢的心得,重点是Symbols Path设置_$firecat全宏的代码足迹$-CSDN博客_cdb.exewindows系统下主要的调试器: ...
Qt creator使用笔记
快捷键设置 Tools->options->environment->keyboard 查找定位当前文件中查找 ctrl+f 项目中查找 Tools->locate (ctr ...
windows10下安装opencv3.2+QT Creator+MingGW
一.安转步骤 download QT5.9 download Cmake download openCV3.2 sources code make & make insatll opencv ...
Qt Creator 快捷键
简介 Qt Creator中提供了各种快捷键来加快开发进程. 如果需要查看或自定义快捷键,选择工具->选项->环境->键盘.快捷键按类别列出,可以在过滤器(Filter)处输入命令名 ...
Qt Creator用法详解
Qt自带集成开发环境(IDE),名为Qt Creator.它可以在Linux.OS X和Windows上运行,并提供智能代码完成.语法高亮.集成帮助系统.调试器和剖析器集成,还集成了所有主要的版本控制 ...

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

【转载】Qt Creator 添加自定义注释相关推荐

最新文章

热门文章