Qt QtCreator添加自定义注释

news2024/11/26 20:22:27

在写代码的时候我们为了规范化，一般会加文件注释、类注释和函数注释；用注释来说明我们的代码，也方便模块化开发，那么我们在写注释的时候经常会写一些重复的内容，我们会复制粘贴。这样一来二去，就显得很繁琐。

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

版权说明
生成日期
作者
功能

下面介绍QtCreator自定义的注释配置。

设置片段

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

文件注释模板：

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

/*! @File        : %{CurrentDocument:FileName}
 *  @Brief       : 简要说明
 *  @Details     : 详细说明
 *  @Author      : xxx
 *  @Date        : %{CurrentDate:yyyy-MM-dd}
 *  @Version     : v1.0
 *  @Copyright   : Copyright By xxx, 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>xxx     <td>创建初始版本
 *  </table>
 *
 **********************************************************
*/

在编辑器中输入filee，按回车，就会打印出注释语句。

类似的还有函数注释、类注释。

函数注释模板：

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

类注释模板：

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

还有一种QtCreator自带的注释：

输入 /** 然后回车就会出现注释语句。