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

原文首发于微信公众号「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: SymbolTypeSymbolTypeSymbolType:description of the return value

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

/// @file FILEBASEFILE_BASEFILEBASE.FILEEXTFILE_EXTFILEEXT
/// @brief ???（函数功能）
///
/// @author yong.qi@bozhon.com
/// @date YEARYEARYEAR-MONTH02MONTH_02MONTH02-DAY02DAY_02DAY02
/// @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视觉工坊】知识星球中给出了介绍，如果愿意学习了解的同学，可以前往查看。

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

pycharm快速添加函数及参数注释_后端开发使用pycharm的技巧
后端开发使用pycharm的技巧 1.使用说明首先说明,本文所使用的功能为pycharm专业版所支持,其他版本如社区版,教育版,则不一定支持. 作为一名后端开发,我猜你的桌面上一定打开着一系列的软件 ...
8 pycharm 快捷键_Pycharm自动添加文件头注释和函数注释参数
Pycharm应该是学python必用的编辑器了,关于它的使用之前已经写过几篇文章,今天再给大家继续介绍两个pycharm的小技巧,希望对大家有用. 1.自动添加文件头注释文件头模板设置路径 Set ...
Pycharm自动添加文件头注释和函数注释参数
Pycharm应该是学python必用的编辑器了,关于它的使用之前已经写过几篇文章,今天再给大家继续介绍两个pycharm的小技巧,希望对大家有用. 1.自动添加文件头注释文件头模板设置路径 Set ...
第10章第3节：使用iSlide往幻灯片快速添加智能参考线 [PowerPoint精美幻灯片实战教程]
本节演示如何往幻灯片快速添加智能参考线,以规范版式的布局.首先点击一键优化命令,显示幻灯片优化功能列表. 选择智能参考线命令,打开智能参考线设置窗口. 此时幻灯片已经显示了智能参考线,如果需要调整参考 ...
IDEA创建方法时快速添加注释
为了方便开发时提高代码的可读性,那么在创建方法时快速添加注释就很有必要. 1.setting => Edit => Live Templates 2. 新建一个组:选择第二个:Templa ...
语音识别快速添加字幕，字幕助手，字幕通
字幕助手是一款免费利用语音识别技术的视频字幕添加软件,这款软件主打视频字幕剪辑和添加功能,能够一键快速添加字幕,同时能够快速导出srt字幕,该软件还具有一键去水印功能,软件可以将繁琐的视频字幕翻译制作 ...
pycharm如何添加文件注释和函数注释
0. Intro 如何自动化写出像这样shai的文件的注释呢: 如何写出这样的函数注释呢,或者说函数的描述?鼠标放上去就自动显示描述,而且在括号内ctrl+p可以显示变量提示. 本文以pycharm为 ...
Mysql使用存储过程快速添加百万数据
这篇文章主要介绍了Mysql使用存储过程快速添加百万数据,本文通过实例代码给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下前言为了体现不加索引和添加索引的区别, ...
jupyter添加标题、文字注释
转载:jupyter添加标题.文字注释本文将分上下两部分简单介绍Jupyter notebook的入门教程,英文原文出处: Getting started with the Jupyter note ...

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

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

最新文章

热门文章