Visual Assist X Options 注释设置-类

目录

类的注释,如下图显示snippet源

其中的snippet代码如下

实际结果展示

其他类的snippet代码

方法注释

结果如下

文件注释


类的注释,如下图显示snippet源

其中的snippet代码如下

//基本信息///
// ><免责声明 ><  Copyright (c) $YEAR$-$YEAR$ by Xie Zhimin All Rights Reserved
// ><创建日期 ><  $DATE$
// ><创建时间 ><  $YEAR$年:$MONTH_02$月:$DAY_02$日   $HOUR_02$时:$MINUTE$分:$SECOND$秒
// ><文件     ><  $FILE_BASE$.$FILE_EXT$
// ><文件路径 ><  $FILE_PATH$
// ><隶属工程><   $projName$
// ><当前用户 ><  %USERNAME%
// ><作者     ><  $Author$
// ><出处     >< 《$reference$》
// ><目的     >< 【$purpose$】
// ><设计技术 >< 
// ><         ><  1.
// ><         ><  2.
// ><         ><  3.
// ><         ><  4.
//迭代修改///
// ><作者     ><  $Author$
// ><修改日期 ><  $YEAR$年:$MONTH_02$月:$DAY_02$日   $HOUR_02$时:$MINUTE$分:$SECOND$秒
// ><原因     ><  
// ><         ><  1.
// ><         ><  2.
// ><         ><  3.
/

实际结果展示

//基本信息///
// ><免责声明 ><  Copyright (c) 2016-2016 by Xie Zhimin All Rights Reserved
// ><创建日期 ><  2016/09/03
// ><创建时间 ><  2016年:09月:03日   12时:04分:05秒
// ><文件     ><  vvvvvv.h
// ><文件路径 ><  E:\ssss\dddd\hehe\hehe
// ><隶属工程><   工程名称
// ><当前用户 ><  Administrator
// ><作者     ><  谢志敏
// ><出处     >< 《http://www.autodesk.com/cn/3dsmax/2012help/index.html?url=files/GUID-65B76EDE-2219-417F-9BB5-36807411590-3591.htm,topicNumber=d28e605061》
// ><目的     >< 【完成3D模型设计】
// ><设计技术 >< 
// ><         ><  1.
// ><         ><  2.
// ><         ><  3.
// ><         ><  4.
//迭代修改///
// ><作者     ><  谢志敏
// ><修改日期 ><  2016年:09月:03日   12时:04分:05秒
// ><原因     ><  
// ><         ><  1.
// ><         ><  2.
// ><         ><  3.
/

其他类的snippet代码

//基本信息///  
// ><免责声明 ><  Copyright (c) $YEAR$-$YEAR$ by Xie Zhimin All Rights Reserved  
// ><创建日期 ><  $DATE$  
// ><创建时间 ><  $YEAR$年:$MONTH_02$月:$DAY_02$日   $HOUR_02$时:$MINUTE$分:$SECOND$秒  
// ><文件     ><  $FILE_BASE$.$FILE_EXT$  
// ><文件路径 ><  $FILE_PATH$  
// ><隶属工程 ><   $projName$  
// ><当前用户 ><  %USERNAME%  
// ><作者     ><  $Author$  
// ><出处     >< 《$reference$》 
// ><参考文章 >< 《$ReferenceArticle$》  
// ><目的     >< 【$purpose$】  
// ><设计技术 ><   
// ><         ><  1.  
// ><         ><  2.  
// ><         ><  3.  
// ><         ><  4.  
//迭代修改///  
// ><作者     ><  $Author$  
// ><修改日期 ><  $YEAR$年:$MONTH_02$月:$DAY_02$日   $HOUR_02$时:$MINUTE$分:$SECOND$秒  
// ><原因     ><    
// ><         ><  1.  
// ><         ><  2.  
// ><         ><  3.  
/
//使用环境///
// ><   √     ><  |
// ><         ><  | 1 平台
// ><         ><  |		1.1 windows
// ><         ><  |		1.2 linux
// ><         ><  |		1.3 mac
// ><         ><
// ><         ><
// ><         ><  | 2 客户端
// ><         ><  |		2.1 windows
// ><         ><
// ><         ><
// ><         ><  | 3 浏览器
// ><         ><  |		3.1 是否需要使用服务
// ><         ><  |			3.1.1 lighttpd
// ><         ><  |			3.1.2 apache
// ><         ><  |			3.1.3 nginx
// ><         ><  |		3.2 浏览器兼容性
// ><         ><  |			3.2.1 Internet Explorer(微软公司旗下浏览器)
// ><         ><  |			3.2.2 google chrome(google旗下浏览器)
// ><         ><  |			3.2.3 firefox(mozilla公司旗下浏览器)
// ><         ><  |			3.2.4 safari(苹果公司旗下浏览器)
// ><         ><  |			3.2.5 opera(挪威厂商opera旗下浏览器)
// ><         ><  | 4 字符集
// ><         ><  |		4.1 ANSI
// ><         ><  |		4.2 UTF-8
// ><         ><  |		4.3 Unicode
// ><         ><  |		4.4 Unicode big endian
/  

其他类注释--

//基本信息///
// ><免责声明 Disclaimer      ><  Copyright (c) $YEAR$-$YEAR$ by xzm_cn@163.com All Rights Reserved
// ><创建日期 Creation date   ><  $DATE$
// ><创建时间 Creation time   ><  $YEAR$/$MONTH_02$/$DAY_02$   $HOUR_02$:$MINUTE$:$SECOND$
// ><文件类型 file type       ><  $FILE_BASE$.$FILE_EXT$
// ><主工程   Main engineering><   
// ><当前用户 Current user    ><  %USERNAME%
// ><作者     author          ><  xzm_cn
// ><出处     reference       ><  
// ><目的     purpose         ><  
// ><涉及技术 involving technolog>< 
// ><         ><  1.
// ><         ><  2.
// ><         ><  3.
// ><         ><  4.
//迭代修改///
// ><作者     author           ><  xzm_cn
// ><修改日期 modification date><  $YEAR$/$MONTH_02$/$DAY_02$   $HOUR_02$:$MINUTE$:$SECOND$
// ><原因     Reason           ><  
// ><                         ><  1.
// ><                         ><  2.
// ><                         ><  3.
/

方法注释

//************************************
// Method:      $SymbolName$
// FullName:    $SymbolContext$
// Access:      $SymbolVirtual$$SymbolPrivileges$$SymbolStatic$
// Qualifier:    $MethodQualifier$
// Extend Note: 
// File:        $FILE_BASE$.$FILE_EXT$
// author:      xzm@$YEAR$:$MONTH_02$:$DAY_02$-$HOUR_02$:$MINUTE$:$SECOND$
// Returns:     $SymbolType$
// Parameter:   $MethodArg$
//************************************

结果如下

//************************************
// Method:      EventRecordCallback
// FullName:    EventRecordCallback
// Access:      public 
// Qualifier:   接收数据的回调函数
// Extend Note: 可以调用SetTraceCallback 设置单独事件GUID的回调函数,即使如此,EventCallback仍然会收到所有的事件
// File:        TestMonitor.cpp
// author:      xzm@2018:08:12-23:39:23
// Returns:     VOID WINAPI
// Parameter:   __in PEVENT_RECORD Event
//************************************
VOID WINAPI EventRecordCallback(__in PEVENT_RECORD Event) {
	if(IsEqualGUID(Event->EventHeader.ProviderId, ProcessGuid)) {
		/* 需要解析数据格式 */
		printf("EventRecordCallback  ProcessGuid!\n");
	}
	printf("EventRecordCallback!\n");
}

文件注释

// 
// $FILE_BASE$.$FILE_EXT$
// 
/
// 
// Author  : xzm@$YEAR$:$MONTH_02$:$DAY_02$-$HOUR_02$:$MINUTE$:$SECOND$
// 
// Tutorial: 
// 
// purpose : 
// 
// Link    : 
// 

 

 

评论 1
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值