QT|QT中自定义注释模板整理 Qt|c++

1、文件头怎么自定义生成注释比如我们要生成如下模板样式：

/****************************************************************************** * Copyright 2020-xxxx xxx Co., Ltd. * All right reserved. See COPYRIGHT for detailed Information. * * @fileXXX.h * @briefXXXX Function * * @authorxxx * @date2020/xx/xx * @history1. *****************************************************************************/

打开Qt Creator，选择“工具”->“选项”，再次选择“文本编辑器”->“片段”->“添加”，按照图上编辑好触发；

文章图片

然后在文本框中填写如下文件头注释模板（日期和文件名可自动生成）。

/****************************************************************************** * Copyright 2020-xxxx xxx Co., Ltd. * All right reserved. See COPYRIGHT for detailed Information. * * @file%{CurrentDocument:FileName} * @briefXXXX Function * * @authorxxx * @date%{CurrentDate:yyyy\/MM\/dd} * @history *****************************************************************************/

选择“应用”，“OK”。接下来，在.c/.cpp/.h中均可，在文件头部位置输入header，回车，即可自动生成注释。

文章图片

文章图片

2、其他常用注释的使用 QT中除了文件头注释不能自动生成，其他的注释都可以自动生成。所以接下来将直接使用了，下面的操作，
即使没有第1节中的设置也可以，属于qt自带。
（1）头文件中
a.类头注释模板

/** * @brief 类的简单概述 * 类的详细概述 */

操作：在类头部上一行，输入/**，然后回车。

文章图片

b.成员变量注释模板

///< 成员变量简要说明，单行注释或者 /** * @brief m_Imagetimer * 成员变量简要说明，多行注释 */

单行注释操作：手敲。

文章图片

多行注释操作：在变量上一行，输入/**，然后回车。

文章图片

【QT|QT中自定义注释模板整理】
（2）源文件中
函数头注释模板：

/* * @brief函数功能说明 * * 解释复杂代码块的流程 * * @param a 参数a说明 * @param b 参数b说明 * * @return 返回值描述 */

操作：在函数头部上一行输入/**，然后回车。

文章图片

3、总结 Qt中其实基本上都可以通过/**来生成各种注释，同时这种注释也是可以被doxygen解析的。
另外自己只需要自定义文件头模板，再配合Qt自带的注释生成方式，就可以很容易生成便于使用doxygen生成api文档的注释。

参考注释与doxygen生成文档样子的链接：
https://blog.csdn.net/czyt1988/article/details/8901191?depth_1-utm_source=distribute.pc_relevant.none-task-blog-BlogCommendFromMachineLearnPai2-1&utm_source=distribute.pc_relevant.none-task-blog-BlogCommendFromMachineLearnPai2-1