C++代码 Visual Assist X + VS2008 添加自定义头文件说明和函数注释

　　先上代码注释效果：

//********************************************************************
// 创建时间： 2013/12/05  11:20
//
// 文件名称:  Helper.h 
//
// 文件作者:  fanchenglong
//====================================================================
// 功能说明:  帮助类
//
// 其他说明:  
//********************************************************************
#pragma once

#include "stdafx.h"

class CHelperEx
{
public:
    CHelperEx();

    ~CHelperEx();

    //********************************************************************
    // 函数名称：S2WS
    //====================================================================
    // 参    数：将string转为wstring
    //
    // 返 回 值：std::wstring
    //
    // 作    者：fanchenglong
    //********************************************************************
    wstring S2WS(const string& s);

    //********************************************************************
    // 函数名称：获取操作系统版本
    //====================================================================
    //
    // 返 回 值：std::string
    //
    // 作    者：fanchenglong
    //********************************************************************
    string GetSystemName();
    
    
    //********************************************************************
    // 函数名称：获取操作系统位数
    //====================================================================
    //
    // 返 回 值：std::string
    //
    // 作    者：fanchenglong
    //********************************************************************
    string GetSystemBit();
};

　　一、如何使用Visual Assist X添加头文件和函数注释内容？

　　头文件注释：先将光标定位到文件头部，VS08菜单中点击“VAsistX->Insert VA Snippets..->（显示可以插入的各种VA脚本）VA Snippets with $selected$->File header detailed”。

　　函数注释：右击需添加注释的函数名->Refactor(VA X)->Document Methord。

　　

　　二、如何自定义？

　　打开自定义注释样式编辑框说明：VS08菜单中点击“VAsistX->Insert VA Snippets..->File header detailed和Refactor Document Methord”，在右侧就可以更改你的文件头和函数头的自定义样式了。

　　1、

　　

　　2、

　　

　　3、

　　

 

　　三、文章开头代码中自定义的注释样式如下：

　　

用于头文件的说明
//********************************************************************
// 创建时间：$DATE$  $HOUR$:$MINUTE$
//
// 文件名称：$FILE_BASE$.$FILE_EXT$ 
//
// 文件作者：fanchenglong
//====================================================================
// 功能说明：$end$
//
// 其他说明：$selected$
//********************************************************************


用于函数注释
//********************************************************************
// 函数名称：$SymbolName$
//====================================================================
// 参    数：$MethodArg$
//
// 返 回 值：$SymbolType$
//
// 作    者：fanchenglong
//********************************************************************