VS2005中用CodeSnippets提高开发效率

新近编译的一篇关于vs.net 2005中code snippets的文章&＃xff0c;原文发表在http://dev.yesky.com/msdn/432/2340932.shtml上&＃xff0c;下面转过来这里

在VS.NET 2005中&＃xff0c;新增加了许多新的特性和功能。其中在方便用户编程方面有了很大的改进&＃xff0c;比如新增加了code snippets&＃xff08;代码片断助手&＃xff09;功能。所谓的code snippets&＃xff0c;是用户可以在编程过程中&＃xff0c;将经常要用到的一些常用代码或者值得收藏起来的代码保存起来&＃xff0c;在要使用的时候就可以方便地调用出来。本文将介绍如何将vs.net 2005自带的code snippets加到已有的应用程序中去&＃xff0c;以及如何建立自己的snipeets,如何使用开源的snippet editor。

　　首先我们来看下如何往已有的程序中插入code snippet。在vs.net 2005中&＃xff0c;已经预先设置了很多平时我们会用到的code snippets了&＃xff0c;比如for loops语句&＃xff0c;又或者调用sqlcommand对象的executeReader方法等代码片段&＃xff0c;要用到的时候&＃xff0c;只需要调用这些code snippets就可以很方便的操作。

　　要在现有的代码中插入code snippets,在要插入的位置&＃xff0c;右键弹出的菜单中&＃xff0c;选择"insert snippet"或者同时按下CTRL&＃43;K&＃43;X组合键。这时会在当前光标位置弹出系统的snippet供用户选择&＃xff0c;如果要取消返回代码状态&＃xff0c;则只需要按ESC键就可以取消了。

　　Snipptets会根据你所使用的语言而有所不同而显示不同的格式&＃xff0c;如果你使用的是VB.net,则snippets会以图1的方式显示&＃xff0c;如果使用的是c#,则以图2的方式显示&＃xff0c;如果当前编辑的是xml,则以图3的方式显示。
   







下面我们来具体看一个例子&＃xff0c;假设你要为一个类添加属性&＃xff0c;一般来说你要输入一大段代码&＃xff0c;比如还要添加getter/setter方法。如果用snippets的话&＃xff0c;将会十分方便。首先&＃xff0c;我们在要增加属性的代码中&＃xff0c;如果使用的是c#,按上文说的方法&＃xff0c;右键弹出菜单中选择"insert snippets",然后再选择"visual c#",再在弹出的菜单中选择"prop"(property的缩写),又或者直接输入prop,再按tab键&＃xff0c;则可以自动生成一个添加属性的普通代码&＃xff0c;包括了getter/setter方法&＃xff0c;当然你还要改参数的名称&＃xff0c;如下代码所示&＃xff1a;

private int myVar; public int MyProperty { 　get { return myVar; } 　set { myVar &＃61; value; } }

　　要注意的是&＃xff0c;在上面的代码中&＃xff0c;比如要修改myVar为另外的参数名&＃xff0c;只需要点选myVar这个参数&＃xff0c;此时参数会被一个绿色的小方框包住&＃xff0c;当你修改为自己的参数后&＃xff0c;只需要按回车键&＃xff0c;则下文中所有的相关参数都会被同时修改。

　　如果使用的是vb.net,则也有两种方法实现。可以在要插入的位置选insert snippets&＃xff0c;再选择"common code patterns",在弹出的菜单中继续选择" Properties and Procedures",最后选择"Define a Property",则会自动生成添加属性的普通代码&＃xff1b;如果要简单快捷的话&＃xff0c;则可以输入property&＃xff0c;并按TAB键&＃xff0c;则同样可以实现,生成的代码如下所示&＃xff1a;

Private newPropertyValue As Integer Public Property NewProperty() As Integer Get 　Return newPropertyValue End Get Set(ByVal value As Integer) 　newPropertyValue &＃61; value End Set End Property

　　值得一题的是&＃xff0c;c#和xml snippets都有一个额外的功能叫"Surround with"&＃xff0c;就是说可以将已经存在的一段代码放到snippets助手中去&＃xff0c;比如有下面的代码&＃xff1a;

string[] arr &＃61; new string[4] {"This","is","a","test"}; string DisplayString&＃61;string.Empty; DisplayString &＃43;&＃61; arr[0]; MessageBox.Show(DisplayString);

　　假如你想增加一个循环语句&＃xff0c;来实现字符串的相加&＃xff0c;那么可以先用鼠标选择DisplayString &＃43;&＃61; arr[0];&＃xff0c;然后在右键弹出的菜单中选择"surround with"&＃xff0c;再在弹出的菜单中选择"for",则系统会自动添加如下所示的语句&＃xff1a;

for (int i &＃61; 0; i &＃xff1c; length; i&＃43;&＃43;) { 　DisplayString &＃43;&＃61; arr[0]; }

　　接下来我们谈下如何管理这些代码snippets。在vs.net 2005中&＃xff0c;使用code snippets manager管理器来管理这些snippets,code snippets manager在tools工具菜单下可以找到&＃xff0c;如下图&＃xff1a;


对于vb.net,visual c#,Visual j#,xml&＃xff0c;snippets管理器都分类列出了有哪些代码助手&＃xff0c;点选每一个代码片断&＃xff0c;同时列出了其存放的位置。还提供了增加&＃xff0c;删除&＃xff0c;导入&＃xff0c;在线查询代码助手的功能。
最后&＃xff0c;我们看下如何自定义snippets。首先研究下snippets的结构&＃xff0c;以上文提到的属性snippets为例子&＃xff0c;我们先在snippets管理器中&＃xff0c;找到prop这个snippets,然后记下其所在的路径&＃xff0c;然后再用编辑工具打开这个文件&＃xff0c;可以看到如下的代码&＃xff0c;注意是以xml格式组织的。

&＃xff1c;?xml version&＃61;"1.0" encoding&＃61;"utf-8" ?&＃xff1e; &＃xff1c;CodeSnippets xmlns&＃61;"http://schemas.microsoft.com/VisualStudio/2005/CodeSnippet"&＃xff1e; &＃xff1c;CodeSnippet Format&＃61;"1.0.0"&＃xff1e; &＃xff1c;Header&＃xff1e; &＃xff1c;Title&＃xff1e;prop&＃xff1c;/Title&＃xff1e; &＃xff1c;Shortcut&＃xff1e;prop&＃xff1c;/Shortcut&＃xff1e; &＃xff1c;Description&＃xff1e;Code snippet for property and backing field&＃xff1c;/Description&＃xff1e; &＃xff1c;Author&＃xff1e;Microsoft Corporation&＃xff1c;/Author&＃xff1e; &＃xff1c;SnippetTypes&＃xff1e; &＃xff1c;SnippetType&＃xff1e;Expansion&＃xff1c;/SnippetType&＃xff1e; &＃xff1c;/SnippetTypes&＃xff1e; &＃xff1c;/Header&＃xff1e; &＃xff1c;Snippet&＃xff1e; &＃xff1c;Declarations&＃xff1e; &＃xff1c;Literal&＃xff1e; &＃xff1c;ID&＃xff1e;type&＃xff1c;/ID&＃xff1e; &＃xff1c;ToolTip&＃xff1e;Property type&＃xff1c;/ToolTip&＃xff1e; &＃xff1c;Default&＃xff1e;int&＃xff1c;/Default&＃xff1e; &＃xff1c;/Literal&＃xff1e; &＃xff1c;Literal&＃xff1e; &＃xff1c;ID&＃xff1e;property&＃xff1c;/ID&＃xff1e; &＃xff1c;ToolTip&＃xff1e;Property name&＃xff1c;/ToolTip&＃xff1e; &＃xff1c;Default&＃xff1e;MyProperty&＃xff1c;/Default&＃xff1e; &＃xff1c;/Literal&＃xff1e; &＃xff1c;Literal&＃xff1e; &＃xff1c;ID&＃xff1e;field&＃xff1c;/ID&＃xff1e; &＃xff1c;ToolTip&＃xff1e;The variable backing this property&＃xff1c;/ToolTip&＃xff1e; &＃xff1c;Default&＃xff1e;myVar&＃xff1c;/Default&＃xff1e; &＃xff1c;/Literal&＃xff1e; &＃xff1c;/Declarations&＃xff1e; &＃xff1c;Code Language&＃61;"csharp"&＃xff1e;&＃xff1c;![CDATA[private $type$ $field$; public $type$ $property$ { 　get { return $field$;} 　set { $field$ &＃61; value;} } $end$]]&＃xff1e; &＃xff1c;/Code&＃xff1e; &＃xff1c;/Snippet&＃xff1e; &＃xff1c;/CodeSnippet&＃xff1e; &＃xff1c;/CodeSnippets&＃xff1e;

　　在上面的代码中&＃xff0c;其中的header部分简单描述了关于这个snippets的信息&＃xff0c;如名称&＃xff0c;快捷方式&＃xff0c;作者&＃xff0c;备注等。在&＃xff1c;snippets&＃xff1e;节点下&＃xff0c;则逐个定义了在snippets中出现的属性&＃xff0c;其中&＃xff1c;default&＃xff1e;指出了该属性默认的值。而在关键部分&＃xff1c;code&＃xff1e;&＃xff0c;用&＃xff1c;![CDATA]&＃xff1e;的方式定义了snippets的基础架构&＃xff0c;其中用$参数名的方式定义每个属性&＃xff0c;十分简单。

　　如果要创建自己的snippets&＃xff0c;是十分简单的&＃xff0c;最简单的是使用比如记事本等编辑工具&＃xff0c;新建一个后缀为snippet的 XML文件&＃xff0c;仿照上面的格式就可以设计了。当完成后&＃xff0c;可以在snippets管理器中通过导入完成的snippet就可以增加一个新的snippet了。此外&＃xff0c;还可以到http://msdn.microsoft.com/vbasic/downloads/tools/snippeteditor/去下载一个snippet 编辑器&＃xff0c;可以方便地进行编辑snippet。

　　在启动这个snippets编辑器后&＃xff0c;默认使用的是vb.net,如下图所示。如果想查看已经存在的snippets,可以先在鼠标右键弹出的菜单中选择"add path",然后添加vb.net的snippets所在的路径&＃xff08;默认是vs.net 2005安装目录下\VB\Snippets子目录中&＃xff09;,则可以很方便地查看已经存在的snippets的代码了。如果想查找已有的snippets,则可以在左上角的文本框中输入要搜索的内容&＃xff0c;再按绿色的apply按钮就可以查找了。

假如要创建自己的snippets时&＃xff0c;可以首先在左则已有的目录下增加一个snippets,比如现在要创建一个叫InstanceProperty的snippets,可在common code patterns分类下的proerties and procedures子类添加&＃xff0c;将其命名为InstanceProperty。

　　接着&＃xff0c;在右边的编辑窗口中&＃xff0c;可以按照snippets的规则写入如下的代码&＃xff1a;

Private $PrivateVariable$ As $PropertyType$ Public Property $PropertyName$() As $PropertyType$ Get 　If $PrivateVariable$ Is Nothing Then 　　$PrivateVariable$ &＃61; New $PropertyType$ 　End If 　Return $PrivateVariable$ End Get Set(ByVal value As $PropertyType$) 　$PrivateVariable$ &＃61; value End Set End Property

　　写完后&＃xff0c;可以点选priview选项卡&＃xff0c;来进行效果的预览。而在下方的replacement选项卡中&＃xff0c;是用来进行参数默认的设置的&＃xff0c;当设置默认值后&＃xff0c;只要用户一调用该codesnippet,则对应的参数转换为该默认值&＃xff0c;比如要将PrivateVariable的默认值设置为abc, PropertyType的值可以默认设置为User自定义类型&＃xff0c;PropertyName设置为setUser,则将上述snipeet保存后&＃xff0c;下次调用snippet时&＃xff0c;会转换为以下代码&＃xff1a;

Private abc As User Public Property setUser() As User Get 　If abc Is Nothing Then 　　abc &＃61; New User 　End If Return abc End Get Set(ByVal value As String) 　abc &＃61; value End Set End Property

　　小结

　　本文简单介绍了在vs.net 2005中&＃xff0c;如何使用code snippets代码助手简化编程&＃xff0c;用户可以根据自己的需要&＃xff0c;加入更多自定义的代码助手功能&＃xff0c;这将大大提高工作效率。