脚本之家 服务器常用软件
快捷导航
您的位置：首页 → 软件编程 → C 语言 → Qt QtCreator 自定义注释

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++11的future和promise、parkged_task使用

    C++11的future和promise、parkged_task使用

    这篇文章主要介绍了C++11的future和promise、parkged_task使用，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
    2020-04-04
  • C++中int类型按字节打印输出的方法

    C++中int类型按字节打印输出的方法

    这篇文章主要给大家介绍了关于C++中int类型按字节打印输出的相关资料，文中通过示例代码介绍的非常详细，对大家学习或者使用C++具有一定的参考学习价值，需要的朋友们下面来一起学习学习吧
    2019-05-05
  • 一文读懂c++11 Lambda表达式

    一文读懂c++11 Lambda表达式

    这篇文章主要介绍了c++11 Lambda表达式的相关资料，帮助大家更好的理解和学习C++,感兴趣的朋友可以了解下
    2020-08-08
  • C++如何比较两个字符串或string是否相等strcmp()和compare()

    C++如何比较两个字符串或string是否相等strcmp()和compare()

    这篇文章主要介绍了C++如何比较两个字符串或string是否相等strcmp()和compare()问题,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教
    2023-11-11
  • VC++中HTControl控制类使用之CHTDlgBase对话框基类实例

    VC++中HTControl控制类使用之CHTDlgBase对话框基类实例

    这篇文章主要介绍了VC++中HTControl控制类使用之CHTDlgBase对话框基类,是比较丰富而实用的功能,需要的朋友可以参考下
    2014-08-08
  • C++命名空间namespace的介绍与使用

    C++命名空间namespace的介绍与使用

    今天小编就为大家分享一篇关于C++命名空间namespace的介绍与使用，小编觉得内容挺不错的，现在分享给大家，具有很好的参考价值，需要的朋友一起跟随小编来看看吧
    2018-12-12
  • C++实现教职工信息管理系统课程设计

    C++实现教职工信息管理系统课程设计

    这篇文章主要为大家详细介绍了C++实现教职工信息管理系统课程设计，文中示例代码介绍的非常详细，具有一定的参考价值，感兴趣的小伙伴们可以参考一下
    2022-03-03
  • C语言二维数组应用之井字棋游戏

    C语言二维数组应用之井字棋游戏

    这篇文章主要为大家详细介绍了C语言二维数组应用之井字棋游戏，文中示例代码介绍的非常详细，具有一定的参考价值，感兴趣的小伙伴们可以参考一下
    2022-06-06
  • C语言中怎么在main函数开始前执行函数

    C语言中怎么在main函数开始前执行函数

    C语言中怎么在main函数开始前执行函数呢？下面小编就大家详细的介绍一下。需要的朋友可以过来参考下，希望对大家有所帮助
    2013-10-10
  • 关于C++使用std::chrono获取当前秒级/毫秒级/微秒级/纳秒级时间戳问题

    关于C++使用std::chrono获取当前秒级/毫秒级/微秒级/纳秒级时间戳问题

    这篇文章主要介绍了C++使用std::chrono获取当前秒级/毫秒级/微秒级/纳秒级时间戳,本文通过实例代码给大家介绍的非常详细，对大家的学习或工作具有一定的参考借鉴价值，需要的朋友可以参考下
    2023-07-07

最新评论