使用VA助手如何快速添加注释(按doxygen注释规范)

news/2024/12/22 14:38:43/

原文首发于微信公众号「3D视觉工坊」:使用VA助手如何快速添加注释(按doxygen注释规范)
首先,关于VA助手的破解安装教程,请参考:VS2015 Visual Assist X 破解版安装教程

此处分享一下我在工程中使用VA助手进行快速注释的小技巧,感兴趣的小伙伴可以借鉴下。

第一步:打开VS中的VA助手小工具,见图1。
在这里插入图片描述

第二步:选择「Edit VA Snippets」,见图2。
在这里插入图片描述

第三步:添加对命名空间(namespace)的注释模板,见图3。
其中,对命名空间的注释模板内容demo粘贴如下:
/// @namespace ???
/// @brief ???
在这里插入图片描述

第三步:添加对类(Class)的注释模板,见图4.
其中,对类的注释模板内容demo粘贴如下:

/// @class <class‐name>
/// @brief This is a brief description.
/// @note mattersneeding attention

在这里插入图片描述

第四步:添加对成员函数(method)的注释模板,见图5。
其中,对成员函数的注释模板内容demo粘贴如下:

/// @brief Thisis a brief description.
/// @param[in] inArgName input argument description.type name:purpose(Range)
/// @param[out] outArgName output argument description.
/// @Return: S y m b o l T y p e SymbolType SymbolType:description of the return value
在这里插入图片描述

第五步:对头文件(header)的注释模板,见图6.

/// @file F I L E B A S E FILE_BASE FILEBASE. F I L E E X T FILE_EXT FILEEXT
/// @brief ???(函数功能)
///
/// @author yong.qi@bozhon.com
/// @date Y E A R YEAR YEAR- M O N T H 0 2 MONTH_02 MONTH02- D A Y 0 2 DAY_02 DAY02
/// @since 1.0.0.0
/// @ingroup pcp-filter
/// @Copyright © 2019, BOZHON Precision Industry Technology Co.,Ltd, www.boozhong.com. All rights reserved.

在这里插入图片描述

第六步:对结构体(struct)的注释模板,见图7.

/// @struct DB_INFO???
/// @brief 数据库信息结构体???

在这里插入图片描述

第七步:对枚举类型(enum)的注释模板,见图8.

/// @enum DB_TYPE???
/// @brief 数据库类型???

在这里插入图片描述

第八步:对宏类型(macro)的注释模板,见图9.

/// @brief 导出符号定义
在这里插入图片描述

用法:简单举个例子,比如我们对于filter_t.h的头文件想给出注释,我们只要在VS中,
输入「//Header」,即可得到如下的注释行。
/// @file filter_t.h
/// @brief ???(函数功能)
///
/// @author yong.qi@bozhon.com
/// @date 2019-04-18
/// @since 1.0.0.0
/// @ingroup pcp_filter
/// @Copyright © 2019, BOZHON Precision Industry Technology Co.,Ltd, www.boozhong.com. All rights reserved.

修改下上面的函数功能,写上你对这个函数功能的具体注释即可。

那么,我们为什么要进行按照doxygen注释规范来进行注释呢,这样做有什么好处呢?

我们可以使用上述的注释,快速生成如下图所示的库说明文档。
在这里插入图片描述

在这里插入图片描述
至于doxygen的具体使用方法,我已经在【3D视觉工坊】知识星球中给出了介绍,如果愿意学习了解的同学,可以前往查看。
在这里插入图片描述
在这里插入图片描述


http://www.ppmy.cn/news/222255.html

相关文章

修改va0n的title

va01 va02 va03用于管理销售订单&#xff0c;他们的抬头是&#xff1a;Create Sales Order: Initial Screen。 本文介绍如何通过隐式增强修改它的title:&#xff08;恨透了csdn不能插入图片&#xff09; TCODE: VA01 SYSTEM->>STATUS 双击进入屏幕101 双击module cua…

va_list使用方法

转载自&#xff1a;http://blog.csdn.net/ID314846818/article/details/51074283 VA_LIST 是在C语言中解决变参问题的一组宏&#xff0c;变参问题是指参数的个数不定&#xff0c;可以是传入一个参数也可以是多个;可变参数中的每个参数的类型可以不同,也可以相同;可变参数的每个…

2021-CISCN-fianl-ezj4va

2021-CISCN-fianl-ezj4va 前言 去年国赛决赛的0解Java&#xff0c;后来出现在了DASCTF八月挑战赛&#xff0c;当时不太会Java所以没有看&#xff0c;今天找个时间复现了一下。写的比较简单&#xff0c;具体可以看参考链接中的文章。 代码审计 访问/robots.txt得到文件名可以…

va_list深究

2011-04-21 21:06:11| 分类&#xff1a; C/C|字号 订阅 VA函数&#xff08;variable argument function&#xff09;&#xff0c;参数个数可变函数&#xff0c;又称可变参数函数。C/C编程中&#xff0c;系统提供给编程人员的va函数很少。*printf()/*scanf()系列函数&#xff0…

c语言va_start函数,va_start和va_end,以及c语言中的可变参数原理

FROM&#xff1a;http://www.cnblogs.com/hanyonglu/archive/2011/05/07/2039916.html 本文主要介绍va_start和va_end的使用及原理。 在以前的一篇帖子Format MessageBox详解中曾使用到va_start和va_end这两个宏&#xff0c;但对它们也只是泛泛的了解。 介绍这两个宏之前先看一…

va start linux头文件,va_start/va_end函数-linux

#include void va_start(va_list ap, last); type va_arg(va_list ap, type); void va_end(va_list ap); void va_copy(va_list dest, va_list src); 1:当无法列出传递函数的所有实参的类型和数目时,可用省略号指定参数表 void foo(...); void foo(parm_list,...); 2:函数参数…

va_list语法

va_list &#xff08;1&#xff09;va_list类型&#xff0c;定义该类型变量来指向可变参数的地址。它的定义为&#xff1a; typedef char * va_list;&#xff08;2&#xff09;va_start(va_list, arg)&#xff0c;va_start初始化va_list变量&#xff0c;使得va_list变量指向…

MySQL 两个备机同时挂掉故障分析

来源&#xff1a; 接报线上出现两个5.7.38的备库同时crash&#xff0c;crash堆栈相同&#xff0c;内容如下&#xff1a; stack_bottom 7fd7700b0d30 thread_stack 0x40000 /home/service/app/mysql33066/bin/mysqld(my_print_stacktrace0x2c)[0xf1062c] /home/service/app/m…