MyException - 我的异常网
当前位置:我的异常网» Visual Studio » 创造自己的代码片段(CodeSnippet)

创造自己的代码片段(CodeSnippet)

www.MyException.Cn  网友分享于:2013-08-09  浏览:0次
创建自己的代码片段(CodeSnippet)

前言

工作中经常会写一些重复的代码片段,如自动属性、for循环、Action等等,针对这种情况,VisualStudio已经给我们提供了一个非常方便的功能——代码片段,是我们可以简单的输入几个字母就能生成大段代码。

但是,工作中总会遇到一些重复代码是VisualStudio没有提供的,这时就需要我们自己去编写片段模板了,本文我将简单讲一下如何创建并使用自己的代码片段。

一、模板文件在哪

 在工具-代码片段管理器(快捷键Ctrl+K,B)可以打开代码片段管理器,如下图:

选择模板所属语言,之后就可以看到该语言所拥有的分组,点开分组就可以看到组内的片段模板了,如下图:

在这里就可以看到模板所在的路径了

从资源管理器进入该路径就可以看到后缀名为Snippet的模板文件了,该文件本质为XML文件,可以直接用VS或记事本打开编辑。

二、模板文件格式

 打开后的模板文件是这样的(这里以for为例),各个节点对应的含义我做出了备注

 

 1 <?xml version="1.0" encoding="utf-8"?>
 2 <CodeSnippets xmlns="http://schemas.microsoft.com/VisualStudio/2005/CodeSnippet">
 3     <CodeSnippet Format="1.0.0">
 4         <Header>
 5             <Title>for</Title>                              <!--显示在提示界面及管理器中的标题-->
 6             <Shortcut>for</Shortcut>                        <!--调用时的快捷代码及管理器中的快捷方式-->
 7             <Description>for 循环的代码片段</Description>   <!--显示在提示界面及管理器中的描述-->
 8             <Author>Microsoft Corporation</Author>          <!--显示管理器中的作者信息-->
 9             <SnippetTypes>                                  <!--显示管理器中的片段类型,这段一般只保留Expansion即可-->
10                 <SnippetType>Expansion</SnippetType>          <!--扩展类型,基本所有片段模板均包含此类型-->
11                 <SnippetType>SurroundsWith</SnippetType>      <!--外侧代码,可在光标所在代码外围插入该代码块,快捷键Ctrl+K,S-->
12         <!--有的模板还是Refactoring类型,该类型没有快捷键,也不包含Expansion类型,我们这里不多说明了-->
13             </SnippetTypes>
14         </Header>
15         <Snippet>
16             <Declarations>                                  <!--模板变量-->
17                 <Literal>
18                     <ID>index</ID>                              <!--变量ID,在模板中通过$ID$的方式调用-->
19                     <Default>i</Default>                        <!--变量默认值-->
20                     <ToolTip>索引</ToolTip>                     <!--焦点在变量上时变量的注释-->
21                 </Literal>
22                 <Literal>
23                     <ID>max</ID>
24                     <Default>length</Default>
25                     <ToolTip>最大长度</ToolTip>
26                 </Literal>
27             </Declarations>
28       <!--下面是模板内容-->
29             <Code Language="csharp"><![CDATA[for (int $index$ = 0; $index$ < $max$; $index$++)
30             {
31             $selected$ $end$
32             }]]>
33             </Code>
34         </Snippet>
35     </CodeSnippet>
36 </CodeSnippets>

 我们创建模板时可以直接导出一份VS自带的模板进行更改,代码主体写在Code标记处,用<![CDATA[和]]>括起来

 我们可以看到,上面的模板中还有两个标识并没有在Declarations中声明,分别如下

$selecteds$ 因为该代码片段是扩展类型,编码时可在当前选定代码外围添加(Ctrl+K,S),故此标识代表当前所选代码

$end$  此标识表示结束时(变量调整好后按Enter或者没变量片段的初始)光标所处位置

三、模板文件导入

 这个就简单了,将编辑好的模板直接拷贝到系统模板所在的路径下就可以了。

 

作者:Vulper

欢迎转载,转载请注明出处!

1楼lindexi
我也写了创建代码片的文章 [resharper 自定义代码片](http://lindexi.oschina.io/lindexi//post/resharper-%E8%87%AA%E5%AE%9A%E4%B9%89%E4%BB%A3%E7%A0%81%E7%89%87/)
Re: Vulper
@lindexi,学习了

文章评论

我是如何打败拖延症的
我是如何打败拖延症的
老程序员的下场
老程序员的下场
Java程序员必看电影
Java程序员必看电影
当下全球最炙手可热的八位少年创业者
当下全球最炙手可热的八位少年创业者
2013年美国开发者薪资调查报告
2013年美国开发者薪资调查报告
Google伦敦新总部 犹如星级庄园
Google伦敦新总部 犹如星级庄园
一个程序员的时间管理
一个程序员的时间管理
10个帮程序员减压放松的网站
10个帮程序员减压放松的网站
漫画:程序员的工作
漫画:程序员的工作
总结2014中国互联网十大段子
总结2014中国互联网十大段子
每天工作4小时的程序员
每天工作4小时的程序员
旅行,写作,编程
旅行,写作,编程
老美怎么看待阿里赴美上市
老美怎么看待阿里赴美上市
为什么程序员都是夜猫子
为什么程序员都是夜猫子
写给自己也写给你 自己到底该何去何从
写给自己也写给你 自己到底该何去何从
Web开发者需具备的8个好习惯
Web开发者需具备的8个好习惯
程序员的一天:一寸光阴一寸金
程序员的一天:一寸光阴一寸金
程序员应该关注的一些事儿
程序员应该关注的一些事儿
那些性感的让人尖叫的程序员
那些性感的让人尖叫的程序员
10个调试和排错的小建议
10个调试和排错的小建议
程序员最害怕的5件事 你中招了吗?
程序员最害怕的5件事 你中招了吗?
60个开发者不容错过的免费资源库
60个开发者不容错过的免费资源库
程序员眼里IE浏览器是什么样的
程序员眼里IE浏览器是什么样的
如何区分一个程序员是“老手“还是“新手“?
如何区分一个程序员是“老手“还是“新手“?
“懒”出效率是程序员的美德
“懒”出效率是程序员的美德
Java 与 .NET 的平台发展之争
Java 与 .NET 的平台发展之争
代码女神横空出世
代码女神横空出世
2013年中国软件开发者薪资调查报告
2013年中国软件开发者薪资调查报告
初级 vs 高级开发者 哪个性价比更高?
初级 vs 高级开发者 哪个性价比更高?
那些争议最大的编程观点
那些争议最大的编程观点
程序员和编码员之间的区别
程序员和编码员之间的区别
不懂技术不要对懂技术的人说这很容易实现
不懂技术不要对懂技术的人说这很容易实现
程序员的鄙视链
程序员的鄙视链
亲爱的项目经理,我恨你
亲爱的项目经理,我恨你
Web开发人员为什么越来越懒了?
Web开发人员为什么越来越懒了?
做程序猿的老婆应该注意的一些事情
做程序猿的老婆应该注意的一些事情
为啥Android手机总会越用越慢?
为啥Android手机总会越用越慢?
程序员周末都喜欢做什么?
程序员周末都喜欢做什么?
鲜为人知的编程真相
鲜为人知的编程真相
程序员都该阅读的书
程序员都该阅读的书
程序员必看的十大电影
程序员必看的十大电影
 程序员的样子
程序员的样子
程序猿的崛起——Growth Hacker
程序猿的崛起——Growth Hacker
如何成为一名黑客
如何成为一名黑客
十大编程算法助程序员走上高手之路
十大编程算法助程序员走上高手之路
看13位CEO、创始人和高管如何提高工作效率
看13位CEO、创始人和高管如何提高工作效率
我的丈夫是个程序员
我的丈夫是个程序员
“肮脏的”IT工作排行榜
“肮脏的”IT工作排行榜
编程语言是女人
编程语言是女人
软件开发程序错误异常ExceptionCopyright © 2009-2015 MyException 版权所有