visual assistant保留词与环境变量使用

用visual studio的多半会用到vax助手。绝对是神兵利器啊，智能提示，颜色标识，自动补全。此处重点介绍的是注释添加功能。

如今注释规范是代码质量的一个重要考量因素，很多都要求代码文档化，而且也有doxygen这样的工具可以从注释自动生成设计说明。

一、注释格式样例

在vax中有一个snippet的选项，可以添加注释块。如何定义注释块的格式呢。

/********************************************************************@filename:     $FILE_BASE$.$FILE_EXT$*@author:       %username%*@date:         $DATE$/$HOUR$:$MINITE$:$SECOND$********************************************************************/

按照如上所示的格式设置一段注释格式的话，触发之后，自动就会生成类似下面这样的注释。

/********************************************************************@filename:     MyJob.h*@author:       Administrator*@date:         2017/04/27/18:59:33********************************************************************/

是不是感觉很方便。写规范整齐的注释以后再不用手敲了。直接快捷键操作即可。

那么va总共支持哪些参数呢。

二、预定义关键字

大体来说，分为3类。

1、环境变量

用%evn_name%来引用。不区分大小写，所有操作系统的环境变量均可引用到。

2、保留字符串

如$DATE$，$HOUR$，表示日期、时间中的小时。

Reserved String Meaning Case Variants $FILE$ Full filename with path Yes $FILE_BASE$ Filename without path or extension Yes $FILE_EXT$ Filename extension Yes $FILE_PATH$ Path of file Yes $DAY$ Day of month as number (without leading zero) $DAY_02$ Day of month formatted as “dd” $DAYNAME$ Day abbreviation in locale format Yes $DAYNAME_EN$ Day abbreviation in English Yes $DAYLONGNAME$ Full name of day in locale format Yes $DAYLONGNAME_EN$ Full name of day in English Yes $MONTH$ Month as number (without leading zero) $MONTH_02$ Month formatted as “MM” $MONTHNAME$ Month abbreviation in locale format Yes $MONTHNAME_EN$ Month abbreviation in English Yes $MONTHLONGNAME$ Full name of month in locale format Yes $MONTHLONGNAME_EN$ Full name of month in English Yes $YEAR$ Year as number $MethodName$ Name of containing method $MethodArgs$ Method parameters $ClassName$ Name of containing class $BaseClassName$ Name of base class of containing class $NamespaceName$ Fully qualified namespace name

3、输入占位符

此类为按照模块生成代码块。比如一个for循环。就可以根据已有模块生成一段代码。在生成过程中自己手动填写一下各个参量的变量名即可。

最简单的例子就是在vs中输入一个for之后，出现提示，然后直接回车，直接一段for循环的代码就出来了。

有需要的可去官网继续深入研究下。

www.wholetomato.com

https://docs.wholetomato.com/default.asp?W104