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语言实现经典24点纸牌益智游戏，文中示例代码介绍的非常详细，具有一定的参考价值，感兴趣的小伙伴们可以参考一下2019-10-10
这篇文章主要给大家介绍了关于C++中四个默认成员函数与运算符重载的相关资料，文中通过示例代码介绍的非常详细，对大家具有一定的参考学习价值，需要的朋友们下面来跟着小编一起学习学习吧。2017-08-08
这篇文章主要和大家详细介绍了利用C语言实现倒置字符串的两种方法，文中的示例代码讲解详细，感兴趣的小伙伴可以跟随小编一起动手尝试一下2022-08-08
这篇文章主要介绍了详解C++ 共享数据保护机制的相关资料，帮助大家更好的理解和学习使用c++，感兴趣的朋友可以了解下2021-02-02
这篇文章主要介绍了数据结构之伸展树详解,本文对伸展树（Splay Tree）的单旋转操作、一字型旋转、之字形旋转区间操作等理论知识做了讲解,并给出实现代码,需要的朋友可以参考下2014-08-08
在C语言中整形和浮点型数据的存储方式有所不同,这篇文章主要介绍了C语言整数和浮点数在内存中存储方法的相关资料,文中通过代码介绍的非常详细,需要的朋友可以参考下2025-08-08
这篇文章主要介绍了C++中用new创建二维数组和指针数组实例代码，非常不错，具有参考借鉴价值，需要的朋友参考下2017-03-03
这篇文章主要介绍了C++中的聚合类定义与用法,结合实例形式分析了C++中聚合类的简单定义、使用方法与相关注意事项,需要的朋友可以参考下2017-08-08
这篇文章主要为大家详细介绍了C/C++如何实现跨文件共享全局变量,文中的示例代码讲解详细,具有一定的借鉴价值,感兴趣的小伙伴可以跟随小编一起学习一下2024-01-01
这篇文章主要介绍了C/C++中虚基类的详解及其作用介绍，本文给大家介绍的非常详细，对大家的学习或工作具有一定的参考借鉴价值，需要的朋友可以参考下2021-09-09
最新评论