新近编译的一篇关于vs.net 2005中code snippets的文章,原文发表在 http://dev.yesky.com/msdn/432/2340932.shtml上,下面转过来这里
在VS.NET 2005中,新增加了许多新的特性和功能。其中在方便用户编程方面有了很大的改进,比如新增加了code snippets(代码片断助手)功能。所谓的code snippets,是用户可以在编程过程中,将经常要用到的一些常用代码或者值得收藏起来的代码保存起来,在要使用的时候就可以方便地调用出来。本文将介绍如何将vs.net 2005自带的code snippets加到已有的应用程序中去,以及如何建立自己的snipeets,如何使用开源的snippet editor。
首先我们来看下如何往已有的程序中插入code snippet。在vs.net 2005中,已经预先设置了很多平时我们会用到的code snippets了,比如for loops语句,又或者调用sqlcommand对象的executeReader方法等代码片段,要用到的时候,只需要调用这些code snippets就可以很方便的操作。
要在现有的代码中插入code snippets,在要插入的位置,右键弹出的菜单中,选择"insert snippet"或者同时按下CTRL+K+X组合键。这时会在当前光标位置弹出系统的snippet供用户选择,如果要取消返回代码状态,则只需要按ESC键就可以取消了。
Snipptets会根据你所使用的语言而有所不同而显示不同的格式,如果你使用的是VB.net,则snippets会以图1的方式显示,如果使用的是c#,则以图2的方式显示,如果当前编辑的是xml,则以图3的方式显示。
下面我们来具体看一个例子,假设你要为一个类添加属性,一般来说你要输入一大段代码,比如还要添加getter/setter方法。如果用snippets的话,将会十分方便。首先,我们在要增加属性的代码中,如果使用的是c#,按上文说的方法,右键弹出菜单中选择"insert snippets",然后再选择"visual c#",再在弹出的菜单中选择"prop"(property的缩写),又或者直接输入prop,再按tab键,则可以自动生成一个添加属性的普通代码,包括了getter/setter方法,当然你还要改参数的名称,如下代码所示:
private int myVar;
public int MyProperty
{
get { return myVar; }
set { myVar = value; }
}
要注意的是,在上面的代码中,比如要修改myVar为另外的参数名,只需要点选myVar这个参数,此时参数会被一个绿色的小方框包住,当你修改为自己的参数后,只需要按回车键,则下文中所有的相关参数都会被同时修改。
如果使用的是vb.net,则也有两种方法实现。可以在要插入的位置选insert snippets,再选择"common code patterns",在弹出的菜单中继续选择" Properties and Procedures",最后选择"Define a Property",则会自动生成添加属性的普通代码;如果要简单快捷的话,则可以输入property,并按TAB键,则同样可以实现,生成的代码如下所示:
Private newPropertyValue As Integer
Public Property NewProperty() As Integer
Get
Return newPropertyValue
End Get
Set(ByVal value As Integer)
newPropertyValue = value
End Set
End Property
值得一题的是,c#和xml snippets都有一个额外的功能叫"Surround with",就是说可以将已经存在的一段代码放到snippets助手中去,比如有下面的代码:
string[] arr = new string[4] {"This","is","a","test"};
string DisplayString=string.Empty;
DisplayString += arr[0];
MessageBox.Show(DisplayString);
假如你想增加一个循环语句,来实现字符串的相加,那么可以先用鼠标选择DisplayString += arr[0];,然后在右键弹出的菜单中选择"surround with",再在弹出的菜单中选择"for",则系统会自动添加如下所示的语句:
for (int i = 0; i < length; i++)
{
DisplayString += arr[0];
}
接下来我们谈下如何管理这些代码snippets。在vs.net 2005中,使用code snippets manager管理器来管理这些snippets,code snippets manager在tools工具菜单下可以找到,如下图:
对于vb.net,visual c#,Visual j#,xml,snippets管理器都分类列出了有哪些代码助手,点选每一个代码片断,同时列出了其存放的位置。还提供了增加,删除,导入,在线查询代码助手的功能。
最后,我们看下如何自定义snippets。首先研究下snippets的结构,以上文提到的属性snippets为例子,我们先在snippets管理器中,找到prop这个snippets,然后记下其所在的路径,然后再用编辑工具打开这个文件,可以看到如下的代码,注意是以xml格式组织的。
<?xml version="1.0" encoding="utf-8" ?>
<CodeSnippets xmlns="http://schemas.microsoft.com/VisualStudio/2005/CodeSnippet">
<CodeSnippet Format="1.0.0">
<Header>
<Title>prop</Title>
<Shortcut>prop</Shortcut>
<Description>Code snippet for property and backing field</Description>
<Author>Microsoft Corporation</Author>
<SnippetTypes>
<SnippetType>Expansion</SnippetType>
</SnippetTypes>
</Header>
<Snippet>
<Declarations>
<Literal>
<ID>type</ID>
<ToolTip>Property type</ToolTip>
<Default>int</Default>
</Literal>
<Literal>
<ID>property</ID>
<ToolTip>Property name</ToolTip>
<Default>MyProperty</Default>
</Literal>
<Literal>
<ID>field</ID>
<ToolTip>The variable backing this property</ToolTip>
<Default>myVar</Default>
</Literal>
</Declarations>
<Code Language="csharp"><![CDATA[private $type$ $field$;
public $type$ $property$
{
get { return $field$;}
set { $field$ = value;}
}
$end$]]>
</Code>
</Snippet>
</CodeSnippet>
</CodeSnippets>
在上面的代码中,其中的header部分简单描述了关于这个snippets的信息,如名称,快捷方式,作者,备注等。在<snippets>节点下,则逐个定义了在snippets中出现的属性,其中<default>指出了该属性默认的值。而在关键部分<code>,用<![CDATA]>的方式定义了snippets的基础架构,其中用$参数名的方式定义每个属性,十分简单。
如果要创建自己的snippets,是十分简单的,最简单的是使用比如记事本等编辑工具,新建一个后缀为snippet的 XML文件,仿照上面的格式就可以设计了。当完成后,可以在snippets管理器中通过导入完成的snippet就可以增加一个新的snippet了。此外,还可以到http://msdn.microsoft.com/vbasic/downloads/tools/snippeteditor/去下载一个snippet 编辑器,可以方便地进行编辑snippet。
在启动这个snippets编辑器后,默认使用的是vb.net,如下图所示。如果想查看已经存在的snippets,可以先在鼠标右键弹出的菜单中选择"add path",然后添加vb.net的snippets所在的路径(默认是vs.net 2005安装目录下/VB/Snippets子目录中),则可以很方便地查看已经存在的snippets的代码了。如果想查找已有的snippets,则可以在左上角的文本框中输入要搜索的内容,再按绿色的apply按钮就可以查找了。
假如要创建自己的snippets时,可以首先在左则已有的目录下增加一个snippets,比如现在要创建一个叫InstanceProperty的snippets,可在common code patterns分类下的proerties and procedures子类添加,将其命名为InstanceProperty。
接着,在右边的编辑窗口中,可以按照snippets的规则写入如下的代码:
Private $PrivateVariable$ As $PropertyType$
Public Property $PropertyName$() As $PropertyType$
Get
If $PrivateVariable$ Is Nothing Then
$PrivateVariable$ = New $PropertyType$
End If
Return $PrivateVariable$
End Get
Set(ByVal value As $PropertyType$)
$PrivateVariable$ = value
End Set
End Property
写完后,可以点选priview选项卡,来进行效果的预览。而在下方的replacement选项卡中,是用来进行参数默认的设置的,当设置默认值后,只要用户一调用该codesnippet,则对应的参数转换为该默认值,比如要将PrivateVariable的默认值设置为abc, PropertyType的值可以默认设置为User自定义类型,PropertyName设置为setUser,则将上述snipeet保存后,下次调用snippet时,会转换为以下代码:
Private abc As User
Public Property setUser() As User
Get
If abc Is Nothing Then
abc = New User
End If
Return abc
End Get
Set(ByVal value As String)
abc = value
End Set
End Property
小结
本文简单介绍了在vs.net 2005中,如何使用code snippets代码助手简化编程,用户可以根据自己的需要,加入更多自定义的代码助手功能,这将大大提高工作效率。