Qt添加注释模板

背景

软件：Qt Creator

在写代码的时候我们为了规范化，一般会加文件注释、类注释和函数注释

用注释来说明我们的代码，也方便模块化开发

那么我们在写注释的时候经常会写一些重复的内容，我们会复制粘贴。这样一来二去，就显得很繁琐

能不能有一种注释模板可以嵌套呢？

有的

设置片段

在Qt中我们依次点开【工具】→【选项】→【文本编辑器】→【片段】

然后点击添加

输入我们想要的片段触发，例如filecomment（PS这样的话我们只要在写代码的时候输入filecomment就可以显示代码片段，直接回车就可以输入了）。

然后在下面的方框输入，想要触发的注释片段内容，例如：

/*! @File        : %{CurrentDocument:FileName}
 *  @Brief       : 简要说明
 *  @Details     : 详细说明
 *  @Author      : Kevin
 *  @Date        : %{CurrentDate:yyyy-MM-dd} %{CurrentTime:hh:mm:ss}
 *  @Version     : v1.0
 *  @Copyright   : Copyright By Kevin, All Rights Reserved
 *
 **********************************************************
 *
 *  @Attention   :
 *  @par 修改日志:
 *  <table>
 *  <tr><th>Date       <th>Version   <th>Author    <th>Description
 *  <tr><td>%{CurrentDate:yyyy-MM-dd} <td>1.0       <td>Kevin     <td>创建初始版本
 *  </table>
 *
 **********************************************************

然后点击右下角的Apply就可以了

相类似的代码片段参考如下

类注释

/*!
    @ClassName   : Class
    @Description : Description
    @Author      : Kevin
    @Data        : %{CurrentDate:yyyy-MM-dd} %{CurrentTime:hh:mm:ss}
*/

函数注释

/*!
    @Function    : Name
    @Description : 详细描述
    @Author      : Kevin
    @Parameter   : 参数说明
    @Return      : 返回值说明
    @Output      :
    @Call by     :
    @Date        : %{CurrentDate:yyyy-MM-dd} %{CurrentTime:hh:mm:ss}
    @Modify      : 日期加修改描述
*/

文件注释模板

先将我们的文件注释模板，就是上面的哪个

/*! @File        : %{CurrentDocument:FileName}
 *  @Brief       : 简要说明
 *  @Details     : 详细说明
 *  @Author      : Kevin
 *  @Date        : %{CurrentDate:yyyy-MM-dd} %{CurrentTime:hh:mm:ss}
 *  @Version     : v1.0
 *  @Copyright   : Copyright By Kevin, All Rights Reserved
 *
 **********************************************************
 *
 *  @Attention   :
 *  @par 修改日志:
 *  <table>
 *  <tr><th>Date       <th>Version   <th>Author    <th>Description
 *  <tr><td>%{CurrentDate:yyyy-MM-dd} <td>1.0       <td>Kevin     <td>创建初始版本
 *  </table>
 *
 **********************************************************

写到一个文件里面，例如licensetemplate.txt 注意要保存为 UTF-8 的格式

然后依次点开Qt的【工具】→【选项】→【c++】→【文件命名】

在最下面那里有个license template，在上面点浏览，选中刚才保存的文件

以后在创建新文件的时候，就可以自动的添加文件的注释了，是不是很方便

总结

上面两种方法都挺实用的，平常写代码的时候可以用上

如果你有更好的方案，欢迎在评论区留言

参考博客

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