VC++开发（一）——VC++自定义注释

VC++开发（一）——VC++自定义注释

一、工具安装

    安装好VS2010和Visual Assist X，打开VS2010，点击Visual Assist X Options，即工具栏上的番茄图标或菜单栏VassistX-Visual Assist X Options，会弹出设置对话框，点击Suggestions-->Edit VA Snippets，如下图：

二、新建自定义注释模块

    Shortcut是快捷方式，即需要注释时在编辑器中输入的内容，Title是标题内容，是注释用途。注释的内容需要添加在编辑框中。

三、自定义文件注释模板

注释内容如下：

/*************************************************
// Copyright (C), 2016-2020, XXXX. Co., Ltd.
// File name: $FILE_BASE$.$FILE_EXT$
// Author: Scorpio
// Version: 1.0
// Date: $DATE$ $HOUR_02$:$MINUTE$:$SECOND$
// Description:
// Others:
// History:
// Scorpio
// $DATE$ $HOUR_02$:$MINUTE$:$SECOND$
// 1.0
// build this moudle
*************************************************/ 

四、自定义函数注释模板

注释内容如下：

/*************************************************
// Method: $SymbolName$
// Description:
// Author: Scorpio
// Date: $DATE$：$HOUR_02$:$MINUTE$:$SECOND$
// Returns: $SymbolType$
// Parameter: $MethodArgName$
// History:
*************************************************/

五、自定义注释的使用

    在需要添加注释的文件头或函数前输入file或func，此时VA助手会提示快捷键的标题，选中如Add File’s Comment。按下Tab键，注释的内容将会添加到C++文件中。