使用Visual Studio扩展插件Visual assist X给代码插入注释模板

  Visual Assist 是由Whole Tomato公司为Microsoft Visual Studio开发的一款插件。它对Visual Studio的智能提示功能和代码高亮功能进行了增强,同时还增加了代码提示功能和重构功能,并对程序注释加入了拼写检查功能。它还可以检测一些基本的语法错误,如使用未声明的变量等。

  今天使用这款插件,主要是为了能够进行快速插入注释模板。一个是为了提高编码效率,不用每次都手动一行一行的添加注释;另一个是为了规范代码,因为插入的是模板,保证了注释的一致性,提高代码可读性。

  插件的安装环境如下:

  (1)操作系统:windows 10

  (2)IDE:Visual Studio 2012

  (3)插件版本:Visual Assist X 2089

  安装好插件后,在VS的菜单栏中会出现VASSISTX的菜单选项,直接点击“Insert VA Snippet...”,在弹出的选项框中点击“Edit VA Snippets...”即可进入自定义模板对话框。如下图所示:(也可按照:VASSIATX -> Visual Assist Options...打开设置对话框,在对话框右侧点击“Suggestions”,再选择“Edit VA Snippets...”)

  在这个编辑器中,用户可以自己定义模板,VA中也有预先定义的一些模板,在上图左框中可以看到。其中加粗黑体是模板的Title,而灰色显示则是快捷输入。当你在写代码的过程中输入灰色字体部分,即可联想出黑色粗体对应的模板,按回车键即可插入到代码中,大大方便了代码的编写。例如,输入#in按回车,即可输入#include “”等等。

  当需要自己定义模板时,点击左上角的新建,在对话框右侧填写相应的内容。其中,Title是给用户看的,表示这个新建的模板的主题;Shortcut是给IDE“看”的,当你在IDE中输入Shortcut中的内容,就会联想出下面的模板,按回车即可插入,即Shortcut是你想输入什么内容来告诉IDE你想在代码中插入下面编写的模板。Description同样是给用户看的,方便用户管理模板。

  下面是我用到的函数注释模板,包含函数名、作者、日期、输入、输出、最后修改时间等信息,其代码如下:

/*****************************************************************************
* @function name : $brief$
* @author : xiongmao
* @date : $YEAR$/$MONTH$/$DAY$ $HOUR$:$MINUTE$
* @inparam :
* @outparam :
* @last change :
*****************************************************************************/

  在IDE中输入mark并回车,即可插入如下图所示的函数注释

  Visual Assist X 提供了丰富的宏,为了定义适合自己的模板,读者可以自行到官网或者搜索引擎查询VAX宏的含义。

时间: 2024-08-26 21:23:32

使用Visual Studio扩展插件Visual assist X给代码插入注释模板的相关文章

visual studio 扩展插件

以下插件可用来提高编码效率和正确率,规范编码 DocStubsJs 实现自动js注释功能,使用方法同C#,只不过位置换到了函数内部 Advanced JavaScript outlining 实现js代码分块预处理命令,同C#代码中的#region JavaScript Parser js提示功能扩展,js方法树形折叠等 扩展插件的安装步骤: 搜索到需要的插件后选中并点击按钮“下载”,等待下载完成后点击安装即可.

Visual Studio Code 插件推荐

Visual Studio Code 插件推荐 下载插件方法, 点击左侧最下面一个图标(  扩展  ),输入想要搜索的插件,下载,按提示安装重启VS 即可. 1  HTML代码提示插件 HTML Snippets, 2  HTML CSS 插件 HTML CSS Support  这个支持H5C3 3  浏览器插件 Open in browser  这个打开浏览器的快捷键是alt+b 或者自己在插件搜索browser 4  HTML标签首尾自动补全插件 Auto Rename Tag 5 代码格

最棒的Visual Studio扩展

isual Studio是微软公司推出的开发环境,Visual Studio可以用来创建Windows平台下的Windows应用程序和网络应用程序,也可以用来创建网络服务.智能设备应用程序和Office插件. Visual Studio是微软公司推出的开发环境,Visual Studio可以用来创建Windows平台下的Windows应用程序和网络应用程序,也可以用来创建网络服务.智能设备应用程序和Office插件. 本文介绍17款最棒的Visual Studio扩展: 1. DevColor

【转】角落的开发工具集之Vs(Visual Studio)2017插件推荐

因为最近录制视频的缘故,很多朋友都在QQ群留言,或者微信公众号私信我,问我一些工具和一些插件啊,怎么使用的啊?那么今天我忙里偷闲整理一下清单,然后在这里面公布出来. Visual Studio 2017 扩展 Visual Studio 2017 15.4.4 : 目前是最新的版本号,所有的工具&插件都支持这个版本号.所以请对号入座. ReSharper : 首先的是Resharper,这个基本是目前是我开发过程中必备的工具集,唯一的缺点就是吃内存,所以你的内存要是低于8G,就不要使用它了.它的

Visual Studio Code插件

Visual Studio Code插件 https://www.cnblogs.com/clwydjgs/p/10078065.html 写在前面 在前端开发中,有一个非常好用的工具,Visual Studio Code,简称VS code. 都不用我安利VS code,大家就会乖乖的去用,无数个大言不惭的攻城狮,都被VS code比德芙还丝滑的强大功能所折服. 我是来给大家安利插件的,想做个比较全面的插件集合给大家.网上的我也看过一些,但是都比较零散,时间也久了一些,我结合最近的情况,总结一

码住!Visual Studio扩展工具ReSharper安装指南来了

ReSharper是一个著名的代码生成工具,其能帮助Microsoft Visual Studio成为一个更佳的IDE.实质上,ReSharper特征可用于C#,VB.net,XML,Asp.net,XAML,和构建脚本. 使用ReSharper,你可以进行深度代码分析,智能代码协助,实时错误代码高亮显示,解决方案范围内代码分析,快速代码更正,一步完成代码格式化和清理,业界领先的自动代码重构,高级的集成单元测试方案,和强大的解决方案内导航和搜索. 安装指南 ReSharper是Visual St

安装GO语言环境之安装Visual Studio Code插件

在安装Visual Studio Code插件的时候,由于谷歌的限制,在下载下列插件的时候会报错: go get -u -v github.com/nsf/gocode go get -u -v github.com/rogpeppe/godef go get -u -v github.com/golang/lint/golint go get -u -v github.com/lukehoban/go-find-references go get -u -v github.com/lukeho

Visual Studio超实用插件 - JSlint,VisualSVN,Reflector

Visual Studio十分强大,但也不是万能的,来点小插件加以补充,让你的编程生活更加惬意美好.下面介绍三款本人用的很爽的三个VS插件. 1.JSLint - 折叠JS代码 C#有#region指令可以把代码折叠,这样使得界面更加整洁,逻辑更加清晰,但是JS就没这么好的福利了. 如果您工作中JS写的很多,面对动辄成百上千的脚本,各种品类繁多.眼花缭乱的function,看着满眼的JS脚本,您一定要尝试下这款插件了,实现代码折叠,上千行JS代码管理起来也毫不费力,妈妈再也不用担心我的视力了!

Visual Studio 2010 插件之Resharper

这一系列不是对每个功能的中文帮助,而是我对开发中可能涉及的功能需求,利用Resharper来完成.有些是Visual Studio有的,但是做的不好,有些是没有而Resharper发明的.总的目的都只有一个,就是加快你编写代码的速度.毕竟,我们的终极目标是在5点半前心满意足的关上电脑回家. 诚然,学会一个新的语言,或者一个新的工具,都有一个上手的问题.希望我的文章能够帮助你尽快地熟悉Resharper.在熟悉了它以后,你使用鼠标或者是无效击键的频率会大大地降低.当然这也需要对visual stu