Qt QtCreator添加自定义注释的实现方法

 更新时间:2023年11月03日 11:44:10   作者:Mr.codeee  
在写代码的时候我们为了规范化,一般会加文件注释、类注释和函数注释,本文主要介绍了Qt QtCreator添加自定义注释的实现方法,具有一定的参考价值,感兴趣的可以了解一下

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

说明性文件(例如:.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自带的注释:

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

到此这篇关于Qt QtCreator添加自定义注释的实现方法的文章就介绍到这了,更多相关Qt QtCreator 自定义注释内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家! 

相关文章

  • C语言实现关机小程序

    C语言实现关机小程序

    这篇文章主要为大家详细介绍了C语言实现关机小程序,文中示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2020-02-02
  • C语言实现时间戳转日期的算法(推荐)

    C语言实现时间戳转日期的算法(推荐)

    下面小编就为大家带来一篇C语言实现时间戳转日期的算法(推荐)。小编觉得挺不错的,现在就分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2016-06-06
  • C++中const的常见用法详解

    C++中const的常见用法详解

    const名叫常量限定符,用来限定特定变量,以通知编译器该变量是不可修改的,本文为大家整理了const的几种使用,感兴趣的小伙伴可以跟随小编一起了解一下
    2023-06-06
  • sizeof()的简单介绍

    sizeof()的简单介绍

    sizeof操作符以字节形式给出了其操作数的存储大小
    2013-04-04
  • 基于C语言实现的TCP服务器的流程分析

    基于C语言实现的TCP服务器的流程分析

    本文详细介绍了如何使用C语言编写一个简单的TCP服务器,包括创建套接字、绑定IP和端口、监听连接请求、接受客户端连接、数据接收与发送以及关闭套接字等步骤,最后通过一个简单的示例展示了TCP服务器的基本实现过程
    2024-10-10
  • C语言模拟实现字符串库函数的示例讲解

    C语言模拟实现字符串库函数的示例讲解

    这篇文章主要为大家详细介绍了C语言模拟实现字符串库函数的具体方法,本文通过实例代码给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下
    2023-01-01
  • 查找算法之二分查找的C++实现

    查找算法之二分查找的C++实现

    今天小编就为大家分享一篇关于查找算法之二分查找的C++实现,小编觉得内容挺不错的,现在分享给大家,具有很好的参考价值,需要的朋友一起跟随小编来看看吧
    2018-12-12
  • Qt数据库应用之数据打印到pdf

    Qt数据库应用之数据打印到pdf

    因为xls打开以后用户可以修改数据造假之类的,而pdf默认是不可编辑的,除非借助专业的工具,所以如果想要限定用户导出数据不能被更改,那导出pdf是最佳选择。所以本文将为代价介绍Qt实现数据打印到pdf的方法,需要的可以参考一下
    2022-01-01
  • C++指针与引用的异同

    C++指针与引用的异同

    这篇文章主要介绍了C++指针与引用的异同,文章以C++指针与引用的相关资料结合指针和引用的相同点和区别展开详细内容,需要的朋友可以参考一下
    2021-11-11
  • 详解C语言读取文件求某一列的平均值

    详解C语言读取文件求某一列的平均值

    本文粗浅比较了C语言中常用的几种读取文件的函数的效率,并给出了几段求取某列平均值的代码,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多度进步
    2022-02-02

最新评论