使用VA Snippet Editor 自动生成注释 常用宏

原文 https://blog.csdn.net/cabinriver/article/details/10606307

1、先看下注释生成的效果：

[cpp]  view plain  copy

1. /***************************************************************************** 
2.     *  @COPYRIGHT NOTICE 
3.     *  @Copyright (c) 2013, ChenMH 
4.     *  @All rights reserved 
5.  
6.     *  @file     : TestHead.h 
7.     *  @version  : ver 1.0 
8.  
9.     *  @author   : ChenMH 
10.     *  @date     : 2013/5/17 14:56 
11.     *  @brief    :    
12. *****************************************************************************/  

2、再来说下使用方法：

      1)、 在主菜单中，依次选择【VAssistX->Visual AssistX Options->Advanced->Suggestions】，单击右边的Edit VA Snippets，即可进入编辑。

      2)、选中"c++"->右键->new。即可建立自定义的宏。

      3)、用的时候，在编辑器中输入你定议的Shortcut即可弹出注释补全框。如我的Shortcut是cmh。

      如下图：

      

      下面是我用到的宏：

[cpp]  view plain  copy

1. /***************************************************************************** 
2.     *  @COPYRIGHT NOTICE 
3.     *  @Copyright (c) 2013, ChenMH 
4.     *  @All rights reserved 
5.  
6.     *  @file     : $FILE_BASE$.$FILE_EXT$ 
7.     *  @version  : ver 1.0 
8.  
9.     *  @author   : ChenMH 
10.     *  @date     : $YEAR$/$MONTH$/$DAY$ $HOUR$:$MINUTE$ 
11.     *  @brief    : $brief$ 
12. *****************************************************************************/  

3、Edit VA Snippets用到的宏

[cpp]  view plain  copy

1.  1Date  
2.  2 $DATE$ Year/month/day formatted as %04d/%02d/%02d  
3.  3 $DAY$ Day of month formatted as %d  
4.  4 $DAY_02$ Day of month formatted as %02d  
5.  5 $DAYNAME$ Three-character abbreviation of day  
6.  6 $DAYLONGNAME$ Full name of day  
7.  7 $MONTH$ Month formatted as %d  
8.  8 $MONTH_02$ Month formatted as %02d  
9.  9 $MONTHNAME$ Three-character abbreviation of month  
10. 10 $MONTHLONGNAME$ Full name of month  
11. 11 $YEAR$ Year formatted as %d  
12. 12 $YEAR_02$ Year formatted as %02d  
13. 13Time   
14.    $HOUR$ Hour formatted as %d  
15. 14 $HOUR_02$ Hour formatted as %02d  
16. 15 $MINUTE$ Minute formatted as %02d  
17. 16 $SECOND$ Second formatted as %02d  
18. 17File  
19. 18 $FILE$ Full filename with path*  
20. 19 $FILE_UPPER$ Full filename with path in uppercase*  
21. 20 $FILE_BASE$ Filename without path or extension*  
22. 21 $FILE_BASE_UPPER$ Filename without path or extension in upper case*  
23. 22 $FILE_EXT$ Filename extension*  
24. 23 $FILE_EXT_UPPER$ Filename extension in upper case*  
25. 24 $FILE_PATH$ Path of file*  
26. 25 $FILE_PATH_UPPER$ Path of file in upper case*  
27. 26General  
28. 27 $clipboard$ Current clipboard  
29. 28 $end$ Position of caret after expansion  
30. 29 $selected$ Current selection**  
31. 30 $$ Literal '$' character  
32. 31Symbol Context  
33. 32 $MethodName$ Name of containing method  
34. 33 $MethodArgs$ Method parameters  
35. 34 $ClassName$ Name of containing class  
36. 35 $BaseClassName$ Name of base class of containing class  
37. 36 $NamespaceName$ Name of innermost containing namespace  
38. 37GUID  
39. 38 $GUID_DEFINITION$ Generated GUID formatted for use in a definition  
40. 39 $GUID_STRING$ Generated GUID formatted for use in a string  
41. 40 $GUID_STRUCT$ Generated GUID formatted for use in a struct  
42. 41Refactor  
43. 42 $GeneratedPropertyName$ Property name generated during Encapsulate Field  
44. 43 $MethodArg$ One parameter of the method and its type  
45. 44 $MethodArgName$ One parameter of the method  
46. 45 $MethodArgType$ Type of one parameter of the method  
47. 46 $MethodBody$ Body of implementation  
48. 47 $MethodQualifier$ Optional qualifiers of method  
49. 48 $ParameterList$ Parameters separated by commas  
50. 49 $SymbolContext$ Context and name of method  
51. 50 $SymbolName$ Name of method  
52. 51 $SymbolPrivileges$ Access of method  
53. 52 $SymbolStatic$ Keyword static or blank  
54. 53 $SymbolType$ Return type of method  
55. 54 $SymbolVirtual$ Keyword virtual or blank   

4、官方网站http://www.wholetomato.com/products/features/vasnippets.asp

常用到的几个自动生成注释的宏

1. //1、生成文件头注释  
2. /************************************************************************** 
3.     *  @Copyright (c) $YEAR$, ChenMH, All rights reserved. 
4.  
5.     *  @file     : $FILE_BASE$.$FILE_EXT$ 
6.     *  @version  : ver 1.0 
7.  
8.     *  @author   : ChenMH 
9.     *  @date     : $YEAR$/$MONTH_02$/$DAY_02$ $HOUR_02$:$MINUTE$ 
10.     *  @brief    : $brief$ 
11. **************************************************************************/  
12.   
13. //2、生成函数功能注释  
14. /******************************************************** 
15.     *  @function :  
16.     *  @brief    :  $brief$ 
17.     *  @input    : 
18.     *  @output   : 
19.     *  @return   :  成功返回0，失败返回非0 
20.  
21.     *  @author   :  ChenMH  $YEAR$/$MONTH_02$/$DAY_02$ $HOUR_02$:$MINUTE$ 
22. ********************************************************/  
23.   
24. //3、生成独立事件注释  
25. /******************************************************** 
26.     *  @author   : ChenMH 
27.     *  @date     : $YEAR$/$MONTH_02$/$DAY_02$ $HOUR_02$:$MINUTE$ 
28.     *  @brief    : $brief$ 
29. ********************************************************/  
30. /*******************************************************/  
31.   
32. //4、生成单行标记  
33. //-------By_ChenMH_$YEAR$/$MONTH_02$/$DAY_02$ $HOUR_02$:$MINUTE$  
34.   
35. //5、生成多行标记  
36. /*-----------------By_ChenMH_$YEAR$/$MONTH_02$/$DAY_02$ $HOUR_02$:$MINUTE$-----------------*/  
37. /*------------------------------------------------------------*/