1、文件头怎么自定义生成注释
/******************************************************************************
* Copyright 2020-xxxx xxx Co., Ltd.
* All right reserved. See COPYRIGHT for detailed Information.
*
* @file XXX.h
* @brief XXXX Function
*
* @author xxx<xxx@xxx.com>
* @date 2020/xx/xx
* @history 1.
*****************************************************************************/
打开Qt Creator,选择“工具”->“选项”,再次选择“文本编辑器”->“片段”->“添加”,按照图上编辑好触发;
然后在文本框中填写如下文件头注释模板(日期和文件名可自动生成)。
/******************************************************************************
* Copyright 2020-xxxx xxx Co., Ltd.
* All right reserved. See COPYRIGHT for detailed Information.
*
* @file %{CurrentDocument:FileName}
* @brief XXXX Function
*
* @author xxx<xxx@xxx.com>
* @date %{CurrentDate:yyyy\/MM\/dd}
* @history
*****************************************************************************/
选择“应用”,“OK”。接下来,在.c/.cpp/.h中均可,在文件头部位置输入header,回车,即可自动生成注释。
2、其他常用注释的使用
QT中除了文件头注释不能自动生成,其他的注释都可以自动生成。所以接下来将直接使用了,下面的操作,
(1)头文件中
/**
* @brief 类的简单概述
* 类的详细概述
*/
///< 成员变量简要说明,单行注释
或者
/**
* @brief m_Imagetimer
* 成员变量简要说明,多行注释
*/
(2)源文件中
/*
* @brief 函数功能说明
*
* 解释复杂代码块的流程
*
* @param a 参数a说明
* @param b 参数b说明
*
* @return 返回值描述
*/
3、总结
Qt中其实基本上都可以通过/**来生成各种注释,同时这种注释也是可以被doxygen解析的。
另外自己只需要自定义文件头模板,再配合Qt自带的注释生成方式,就可以很容易生成便于使用doxygen生成api文档的注释。
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
若对你有帮助,欢迎点赞、收藏、评论,你的支持就是我的最大动力!!!
同时,阿超为大家准备了丰富的学习资料,欢迎关注公众号“超哥学编程”,即可领取。