Visual Assist X添加注释模板

最新推荐文章于 2023-10-18 17:35:56 发布

原创最新推荐文章于 2023-10-18 17:35:56 发布 · 3.7k 阅读

7 ·

CC 4.0 BY-SA版权

文章标签：

#visual-assist-x #注释

C++ 专栏收录该内容

4 篇文章

订阅专栏

本文介绍如何使用VisualAssistX创建Doxygen风格的代码注释模板，包括文件、类及函数等不同层级的注释示例。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

1 简介

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

2 添加注释模板

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

Options

在Visual Assist X Options页面依次单击Advanced -> Suggestions -> Edit VA Snippets，打开VA Snippet Editor页面。
在VA Snippet Editor 页面下便可添加Doxygen注释模板。

Editor

2.1 文件注释

添加效果图：

文件注释

模板内容：

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

2.2 class、struct、enum、union等

添加效果图：

class

模板内容：

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

2.3 函数

添加效果图：

模板内容：

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

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

函数使用

最终效果如下图所示：

函数效果