Visual Assist X添加注释模板

1 简介

Visual Assist X是开发环境的辅助工具，使用它可以创建代码注释模板等。在此之前，我们需要先了解一些预定义宏：Visual Assist X预定义宏

2 添加注释模板

在了解了预定义宏且安装好Visual Assist X后，依次单击VAssistX -> Visual Assist Options…打开Visual Assist Options页面。



在Visual Assist X Options页面依次单击Advanced -> Suggestions -> Edit VA Snippets，打开VA Snippet Editor页面。

在VA Snippet Editor 页面下便可添加Doxygen注释模板。

2.1 文件注释

添加效果图：



模板内容：

///////////////////////////////////////////////////////////////////////////////////////////////////
/// @file       $FILE_BASE$.$FILE_EXT$
/// @author     名字
/// @date       $YEAR$.$MONTH_02$.$DAY_02$
/// @brief      $end$
/// @details
///////////////////////////////////////////////////////////////////////////////////////////////////

2.2 class、struct、enum、union等

添加效果图：



模板内容：

/// @brief      $end$
/// @details

2.3 函数

添加效果图：



模板内容：

/// @brief      $end$
/// @details
/// @param[in]  $MethodArgName$:
/// @return
/// @attention

使用方法：

如下图所示，依次单击Refactor(VA X) -> Document Method即可生产函数注释模板。



最终效果如下图所示：

3 相关网站

Visual Assist 官网

Visual Assist 下载

Visual Assist 破解