在Visual Assist X中增加Doxygen格式的注解的模板 [RT，修改]

来源：互联网发布：卖家淘宝试用中心编辑：程序博客网时间：2024/06/05 11:54

在Visual Assist X中增加Doxygen格式的注解的模板 [RT，修改]

Visual Assist X Options->Advanced->Suggestions->Edit VA Snippets

文件的注解：
/* @All Right Reserved (C), 2008-2108, OpenRs.org.*/

//! $end$
/*!
/author : 作者
/date    : $DATE$
/version  : ver 1.0
/filepath : $FILE_PATH$
/filename : $FILE_BASE$.$FILE_EXT$
/note    :

/attention:

/remark : 1.$DATE$ $HOUR$ : $MINUTE$ created by 作者 version 1.0
/History:
<author>    <time>    <version>       <desc>
*/

函数的注解
更改Refactor Document Method为：
//! $end$.
/*!
/author: 作者
/date $DATE$
/version ver1.0
/param $MethodArgName$ -
/exception
/test
/note
/attention
/sa
/remark 1.$DATE$ $HOUR$ : $MINUTE$ created by 作者 version
/return
*/

使用的时候，在要注解的方法上面右键就可以了。

建议的注释

文件头的注释参照gdal的，这个不会生成doxygen文档

//*************************************************************************
//
// Copyright (C) 2009, LIESMARS, Wuhan University
//
// License: LGPL
//
//*************************************************************************
//
// $Id: $FILE_BASE$.$FILE_EXT$ $DATE$ $HOUR$ : $MINUTE$ JWS $
//
// Project: OpenRS
//
// Purpose:
//
// Author: JIANG Wanshou, jws@lmars.whu.edu.cn
//
//*************************************************************************
//
// $Log: $FILE_BASE$.$FILE_EXT$,v $
//
// Revision 1.0 date: $DATE$ by JIANG Wanshou
// new
//
关于版本历史，gdal原先有一个revision。现在取消了。估计是用svn的log代替，建议大家对重要的修改提交的时候写log。这样对每一个文件都可以有修改历史。

如果愿意的话，还是可以在文件头上加上修改的历史记录。

函数的注释，这个只能在VC2005以后的refator右键菜单里起作用，会自动提取参数名
/*!
/param $MethodArgName$ -
/return $SymbolType$
/sa
*/