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

在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
*/
  • 0
    点赞
  • 2
    收藏
    觉得还不错? 一键收藏
  • 0
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值