VS2015自动生成代码注释以及VA_X安装使用教程

最新推荐文章于 2024-08-27 13:02:10 发布

sxj_wyj

最新推荐文章于 2024-08-27 13:02:10 发布

阅读量3.4k

点赞数

分类专栏： vs相关

vs相关专栏收录该内容

4 篇文章 0 订阅

订阅专栏

VS2015自动生成代码注释以及VA_X安装使用教程

landy8530 关注

2017.07.04 11:32* 字数 2054 阅读 784 评论 0 喜欢 2

最近刚刚接触VS2015，对一些默认的代码注释以及快捷键不友好，需要安装VA_X（visual assistant）插件，步骤如下：

1.创建类文件自动生成代码注释

让VS自动生成类的头部注释，需要修改安装目录下的一个 Class.cs文件，具体路径如下：
E:\VS2015\Common7\IDE\ItemTemplatesCache\CSharp\Code
此目录下的均是代码模版，可以修改相应类的模版即可
这个路径下有两个文件夹：

image.png

在2052目录下修改文件E:\VS2015\Common7\IDE\ItemTemplatesCache\CSharp\Code\2052\Class\Class.cs如下：

image.png

效果如下：

image.png

2.VA_X的安装、破解、使用

2.1 下载

下载地址：链接: https://pan.baidu.com/s/1c2fBzjE 密码: 4muj

2.2 安装

安装VA_X之前，请先关闭VS2015
进入VA_X_官方安装程序，并解压，管理员身份运行‘VA_X_Setup2074.exe’文件，安装完成即可。

2.3 破解

2.3.1 Visual Assist X 和谐文件说明：

本和谐文件仅供技术研究，若喜欢 VA_X 请注册购买正版。
通杀VA_X1641_{2073（理论支持后续版本），支持VC6}VS2015，在XP~WIN10系统下测试OK。
采用了更为巧妙的破解方案，不修改任何代码，不延时，不影响VS启动。
为防止作者逆向，文件已加壳，杀软可能会误报，请自行决定是否使用。
部分电脑可能无法注册成功，这个需要看人品，人品佳的请回帖。

2.3.2破解过程：

进入 VA_X 通用破解补丁文件夹，解压后以管理员身份运行‘Visual Assist X 通用破解补丁 v1.2.exe’
出现：

image.png

点击安装，出现下图：

image.png

选择‘是’，出现

image.png

选择‘安装补丁’，很快就安装好了。屏幕上会出现以下提示：

image.png

最后重新打开VS2015，界面会出现：

image.png

以上参考百度经验文章： https://jingyan.baidu.com/article/ea24bc399fccb9da62b331bd.html
如有冒犯，请联系博主删除！谢谢！

2.4 使用

2.4.1 增加函数头注释

右键函数名，然后依次点击“Refacto”–>“Document Method”，这个时候函数头注释就会跳出来

image.png

不过这个注释的格式是默认的，想修改注释格式，可以通过以下方法：
点击 “VAssistX”–>“Visual VAssistX Options”然后选择Suggestions,再点击“Edit VA Snippets”。在打开的窗口中选择Refactor Document Method，在这就可以更改你的显示样式了。

image.png

可以参照默认的注释格式来定制自己的注释：

//************************************
// Method:    $SymbolName</span>$
// FullName:  $SymbolContext</span>$
// Access:    $SymbolVirtual</span>$ $SymbolPrivileges</span>$ $SymbolStatic</span>$ // Returns: $SymbolType</span>$ // Qualifier: $MethodQualifier</span>$ // Parameter: $MethodArg</span>$ //************************************

2.4.2 增加文件头注释

要想在文件头添加注释，需要把鼠标光标定位到VS编辑器的第一行，点击 “VAssistX”–>“Insert VA Snippet…”—>“File Header Detail”，即可增加文件头注释。

image.png

生成的效果如下：

image.png

默认的注释格式如下，可以通过点击“VAssistX”–>“Visual VAssistX Options”—>“Advanced”—>“Suggestions”—>“Edit VA Snippets”，选择你相应语言的“File Header Detail”修改。

image.png

注释模版如下：

/**
* 命名空间: $PROJECT_NAME</span>$
*
* 功 能： N/A
* 类 名： $FILE_BASE_CAMEL</span>$
* 创建人：LANDY
* 创建时间：$YEAR</span>$-$MONTH</span>$-$DAY</span>$ $HOUR</span>$:$MINUTE</span>$:$SECOND</span>$ * Ver 变更日期 负责人 变更内容 * ─────────────────────────────────── * V0.01 $YEAR</span>$-$MONTH</span>$-$DAY</span>$ LANDY 初版 * * Copyright (c) 2017 Lir Corporation. All rights reserved. *┌──────────────────────────────────┐ *│　此技术信息为本公司机密信息，未经本公司书面同意禁止向第三方披露．　│ *│　版权所有：厦门卫生检疫技术研究所 　　　　　　　　　　　　　　 │ *└──────────────────────────────────┘ */

2.4.3 快捷键配置

配置常用的几个快捷键，参照eclipse快捷键方式：
工具—>选项–>环境–>键盘

2.4.3.1 块注释：ctrl+shift+/

image.png

2.4.3.2 取消块注释：ctrl+shift+\

image.png

2.4.3.3 行注释：ctrl+/

image.png

由于VS设置中没有直接取消注释的功能，故无法提供，但是可以选中某一行取消注释，需要可以按如下方式设置:

image.png

2.4.3.4 回到上一个光标位置/前进到下一个光标位置

1）回到上一个光标位置：使用组合键“Ctrl + -”；
2）前进到下一个光标位置：“Ctrl + Shift + - ”。

2.4.3.5 复制/剪切/删除整行代码

1）如果你想复制一整行代码，只需将光标移至该行，再使用组合键“Ctrl+C”来完成复制操作，而无需选择整行。
2）如果你想剪切一整行代码，只需将光标移至该行，再使用组合键“Ctrl+X”来完成剪切操作，而无需选择整行。
3）如果你想删除一整行代码，只需将光标移至该行，再使用组合键“Ctrl+L”来完成剪切操作，而无需选择整行。

2.4.3.6 撤销/反撤销

1）撤销：使用组合键“Ctrl+Z”进行撤销操作；
2）反撤销：使用组合键“Ctrl+Y”进行反撤销操作。

2.4.3.7 向前/向后搜索

1)使用组合键“Ctrl+I”；
2)键入待搜索文本（将光标移至搜索词输入框位置即可开始输入）；
3)键入搜索文本后，可以使用组合键“Ctrl+I”及“Ctrl+Shift+I”前后定位搜索结果，搜索结果会被高亮显示。
4)要结束搜索，可以按“ESC”键或者点击查找框右侧的关闭按钮。

2.4.3.8 在光标所在行的上面或下面插入一行

1）组合键“Ctrl+Enter”：在当前行的上面插入一个空行；
2）组合键“Ctrl+Shift+Enter”：在当前行的下面插入一个空行。

2.4.3.9 定位到行首与行尾

1）home键：定位到当前行的行首；
2）end键：定位到当前行的行尾。

2.4.3.10 选中从光标起到行首(尾)间的代码

1）选中从光标起到行首间的代码：使用组合键“CShift + Home”；
2）选中从光标起到行尾间的代码：使用组合键“Shift + End”。

2.4.3.11 调用智能提示

1）方法1：使用组合键“Ctrl+J”；
2）方法2：使用组合键“Alt+→”。

2.4.3.12 调用参数信息提示

对于某些函数体较大的函数来说，想轻松地确认参数在函数内部的使用情况是件比较麻烦的事情。这时可以将光标置于参数名上，再按组合键“Ctrl+Shif+空格”，参数被使用的地方会被高亮显示。

2.4.3.13 快速切换窗口

使用组合键“Ctrl+Tab”（此时可以打开IDE的导航，获得鸟瞰视图）。

2.4.3.14 快速隐藏或显示当前代码段

使用组合键“Ctrl+M,M”（记住：要按两次M哦）。

2.4.3.15 生成解决方案

使用组合键“Ctrl+Shift+B”。

2.4.3.16 跳转到指定的某一行

1）方法1：组合键“Ctrl+G”；
2）方法2：单击状态栏中的行号。

2.4.3.17 全屏显示/退出全屏显示

使用组合键“ SHIFT + ALT + ENTER ”。

2.4.3.18 定义与引用

1）转跳到定义：F12；
2）查找所有引用：使用组合键“Shift+F12”。

2.4.3.19 查找和替换

1）查找：使用组合键“Ctrl+F”；
2）替换：使用组合键“Ctrl+H”。

2.4.3.20 大小写转换

1）转小写：使用组合键“Ctrl+ U”；
2）转大写：使用组合键“CTRL + SHIFT + U”。

2.4.3.21 调试相关

1）调试（启动）：F5；
2）调试（重新启动）：使用组合键“Ctrl+Shift+F5”；
3）调试（开始执行不调试）：使用组合键“Ctrl+F5”；
4）调试（逐语句）：F11；
5）调试（逐过程）：F10；
6）设置断点：F9。

3.参考链接

常用快捷键：http://blog.csdn.net/anzhongliu/article/details/48750637
文件头注释：http://www.cnblogs.com/xqhppt/p/4149503.html

      </div>
    </div>
</div>

<!-- 如果是付费文章，未购买，则显示购买按钮 -->

<!-- 连载目录项 -->

<!-- 如果是付费文章 -->
  <!-- 如果是付费连载，已购买，且作者允许赞赏，则显示付费信息和赞赏 -->
    <div id="free-reward-panel" class="support-author"><p>小礼物走一走，来简书关注我</p> <div class="btn btn-pay">赞赏支持</div> <div class="supporter"><ul class="support-list"></ul> <!----></div> <!----> <!----></div>

  <div class="show-foot">
    <a class="notebook" href="/nb/14057958">
      <i class="iconfont ic-search-notebook"></i>
      <span>VisualStudio</span>

  <!-- 文章底部作者信息 -->
    <div class="follow-detail">
      <div class="info">
        <a class="avatar" href="/u/36a7d3a994ac">
          <img src="//upload.jianshu.io/users/upload_avatars/5321750/31d0edf2-6846-47e1-8958-4aa4f772780f?imageMogr2/auto-orient/strip|imageView2/1/w/96/h/96" alt="96">

关注
 landy8530

写了 49744 字，被 143 人关注，获得了 244 个喜欢

一个致力于在二线城市挤公交写代码的程序猿！

<div class="meta-bottom">
  <div data-v-6ddd02c6="" class="like"><div data-v-6ddd02c6="" class="btn like-group"><div data-v-6ddd02c6="" class="btn-like"><a data-v-6ddd02c6="">喜欢</a></div> <div data-v-6ddd02c6="" class="modal-wrap"><a data-v-6ddd02c6="">2</a></div></div> <!----></div>
  <div class="share-group">
    <a class="share-circle" data-action="weixin-share" data-toggle="tooltip" data-original-title="分享到微信">
      <i class="iconfont ic-wechat"></i>
    </a>
    <a class="share-circle" data-action="weibo-share" data-toggle="tooltip" href="javascript:void((function(s,d,e,r,l,p,t,z,c){var%20f='http://v.t.sina.com.cn/share/share.php?appkey=1881139527',u=z||d.location,p=['&amp;url=',e(u),'&amp;title=',e(t||d.title),'&amp;source=',e(r),'&amp;sourceUrl=',e(l),'&amp;content=',c||'gb2312','&amp;pic=',e(p||'')].join('');function%20a(){if(!window.open([f,p].join(''),'mb',['toolbar=0,status=0,resizable=1,width=440,height=430,left=',(s.width-440)/2,',top=',(s.height-430)/2].join('')))u.href=[f,p].join('');};if(/Firefox/.test(navigator.userAgent))setTimeout(a,0);else%20a();})(screen,document,encodeURIComponent,'','','', '推荐 @LYX_XM 的文章《VS2015自动生成代码注释以及VA_X安装使用教程》（ 分享自 @简书 ）','https://www.jianshu.com/p/2c580b48550f?utm_campaign=maleskine&amp;utm_content=note&amp;utm_medium=reader_share&amp;utm_source=weibo','页面编码gb2312|utf-8默认gb2312'));" data-original-title="分享到微博">
      <i class="iconfont ic-weibo"></i>
    </a>
    <a class="share-circle" data-toggle="tooltip" id="longshare" target="_blank" data-original-title="" title="">
        <div class="qrcode" id="qrcode">
         <img src="//cdn2.jianshu.io/assets/web/download-index-side-qrcode-cb13fc9106a478795f8d10f9f632fccf.png" alt="Download index side qrcode">
         <p>下载app生成长微博图片</p>
         </div>
      <i class="iconfont ic-picture"></i>
    </a>
    <a class="share-circle more-share" tabindex="0" data-toggle="popover" data-placement="top" data-html="true" data-trigger="focus" href="javascript:void(0);" data-content="
      <ul class=&quot;share-list&quot;>
        <li><a href=&quot;javascript:void(function(){var d=document,e=encodeURIComponent,r='http://sns.qzone.qq.com/cgi-bin/qzshare/cgi_qzshare_onekey?url='+e('https://www.jianshu.com/p/2c580b48550f?utm_campaign=maleskine&amp;utm_content=note&amp;utm_medium=reader_share&amp;utm_source=qzone')+'&amp;title='+e('推荐 landy8530 的文章《VS2015自动生成代码注释以及VA_X安装使用教程》'),x=function(){if(!window.open(r,'qzone','toolbar=0,resizable=1,scrollbars=yes,status=1,width=600,height=600'))location.href=r};if(/Firefox/.test(navigator.userAgent)){setTimeout(x,0)}else{x()}})();&quot;><i class=&quot;social-icon-sprite social-icon-zone&quot;></i><span>分享到QQ空间</span></a></li>
        <li><a href=&quot;javascript:void(function(){var d=document,e=encodeURIComponent,r='https://twitter.com/share?url='+e('https://www.jianshu.com/p/2c580b48550f?utm_campaign=maleskine&amp;utm_content=note&amp;utm_medium=reader_share&amp;utm_source=twitter')+'&amp;text='+e('推荐 landy8530 的文章《VS2015自动生成代码注释以及VA_X安装使用教程》（ 分享自 @jianshucom ）')+'&amp;related='+e('jianshucom'),x=function(){if(!window.open(r,'twitter','toolbar=0,resizable=1,scrollbars=yes,status=1,width=600,height=600'))location.href=r};if(/Firefox/.test(navigator.userAgent)){setTimeout(x,0)}else{x()}})();&quot;><i class=&quot;social-icon-sprite social-icon-twitter&quot;></i><span>分享到Twitter</span></a></li>
        <li><a href=&quot;javascript:void(function(){var d=document,e=encodeURIComponent,r='https://www.facebook.com/dialog/share?app_id=483126645039390&amp;display=popup&amp;href=https://www.jianshu.com/p/2c580b48550f?utm_campaign=maleskine&amp;utm_content=note&amp;utm_medium=reader_share&amp;utm_source=facebook',x=function(){if(!window.open(r,'facebook','toolbar=0,resizable=1,scrollbars=yes,status=1,width=450,height=330'))location.href=r};if(/Firefox/.test(navigator.userAgent)){setTimeout(x,0)}else{x()}})();&quot;><i class=&quot;social-icon-sprite social-icon-facebook&quot;></i><span>分享到Facebook</span></a></li>
        <li><a href=&quot;javascript:void(function(){var d=document,e=encodeURIComponent,r='https://plus.google.com/share?url='+e('https://www.jianshu.com/p/2c580b48550f?utm_campaign=maleskine&amp;utm_content=note&amp;utm_medium=reader_share&amp;utm_source=google_plus'),x=function(){if(!window.open(r,'google_plus','toolbar=0,resizable=1,scrollbars=yes,status=1,width=450,height=330'))location.href=r};if(/Firefox/.test(navigator.userAgent)){setTimeout(x,0)}else{x()}})();&quot;><i class=&quot;social-icon-sprite social-icon-google&quot;></i><span>分享到Google+</span></a></li>
        <li><a href=&quot;javascript:void(function(){var d=document,e=encodeURIComponent,s1=window.getSelection,s2=d.getSelection,s3=d.selection,s=s1?s1():s2?s2():s3?s3.createRange().text:'',r='http://www.douban.com/recommend/?url='+e('https://www.jianshu.com/p/2c580b48550f?utm_campaign=maleskine&amp;utm_content=note&amp;utm_medium=reader_share&amp;utm_source=douban')+'&amp;title='+e('VS2015自动生成代码注释以及VA_X安装使用教程')+'&amp;sel='+e(s)+'&amp;v=1',x=function(){if(!window.open(r,'douban','toolbar=0,resizable=1,scrollbars=yes,status=1,width=450,height=330'))location.href=r+'&amp;r=1'};if(/Firefox/.test(navigator.userAgent)){setTimeout(x,0)}else{x()}})()&quot;><i class=&quot;social-icon-sprite social-icon-douban&quot;></i><span>分享到豆瓣</span></a></li>
      </ul>
    " data-original-title="" title="">更多分享</a>
  </div>
</div>
  <a id="web-note-ad-1" target="_blank" href="/apps/redirect?utm_source=note-bottom-click"><img src="//cdn2.jianshu.io/assets/web/web-note-ad-1-c2e1746859dbf03abe49248893c9bea4.png" alt="Web note ad 1"></a>
<div><div id="comment-list" class="comment-list"><div><form class="new-comment"><a class="avatar"><img src="//cdn2.jianshu.io/assets/default_avatar/avatar_default-78d4d1f68984cd6d4379508dd94b4210.png"></a> <div class="sign-container"><a href="/sign_in?utm_source=desktop&amp;utm_medium=not-signed-in-comment-form" class="btn btn-sign">登录</a> <span>后发表评论</span></div></form> <!----></div> <!----> <div class="comments-placeholder" style="display: none;"><div class="author"><div class="avatar"></div> <div class="info"><div class="name"></div> <div class="meta"></div></div></div> <div class="text"></div> <div class="text animation-delay"></div> <div class="tool-group"><i class="iconfont ic-zan-active"></i><div class="zan"></div> <i class="iconfont ic-list-comments"></i><div class="zan"></div></div></div> <div id="normal-comment-list" class="normal-comment-list"><div><!----> <div><div class="top-title"><span>评论</span> <a class="close-btn" style="display: none;">关闭评论</a></div> <div class="no-comment"></div> <div class="text">
        智慧如你，不想<a href="/sign_in?utm_source=desktop&amp;utm_medium=not-signed-in-nocomments-text">发表一点想法</a>咩~
      </div></div> <!----> <div class="comments-placeholder" style="display: none;"><div class="author"><div class="avatar"></div> <div class="info"><div class="name"></div> <div class="meta"></div></div></div> <div class="text"></div> <div class="text animation-delay"></div> <div class="tool-group"><i class="iconfont ic-zan-active"></i><div class="zan"></div> <i class="iconfont ic-list-comments"></i><div class="zan"></div></div></div> </div></div> <!----> <div><!----></div></div></div>