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

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

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

第一步：打开VS中的VA助手小工具，见图1。

1.png

第二步：选择「Edit VA Snippets」，见图2。

2.png

第三步：添加对命名空间(namespace)的注释模板，见图3。
其中，对命名空间的注释模板内容demo粘贴如下：
/// @namespace ???
/// @brief ???

3.png

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

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

4.png

第四步：添加对成员函数(method)的注释模板，见图5。

5.png

其中，对成员函数的注释模板内容demo粘贴如下：

/// @brief Thisis a brief description.
/// @param[in] inArgName input argument description.type name:purpose(Range)
/// @param[out] outArgName output argument description.
/// @Return: :description of the return value

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

6.png

/// @file .
/// @brief ???（函数功能）
///
/// @author yong.qi@bozhon.com
/// @date --
/// @since 1.0.0.0
/// @ingroup pcp-filter
/// @Copyright (c) 2019, BOZHON Precision Industry Technology Co.,Ltd, www.boozhong.com. All rights reserved.

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

7.png

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

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

8.png

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

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

9.png

/// @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 (c) 2019, BOZHON Precision Industry Technology Co.,Ltd, www.boozhong.com. All rights reserved.

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

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

我们可以使用上述的注释，快速生成如下图所示的库说明文档。

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

在这里插入图片描述
在这里插入图片描述