VS代码片段（CodeSnippet）的制作以及常用代码片段记录

已于 2023-03-17 14:48:51 修改
阅读量3.2k 收藏 12
点赞数 6
分类专栏： C# 文章标签： microsoft c# .net
于 2022-12-14 16:37:04 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/qq_39847278/article/details/128316141
版权

总目录

文章目录

前言

本文将会探索VS中代码片段，并且学会自己制作代码片段，通过这种方式提高我们的编程效率。

一、代码片段是什么？

1.了解

先看下下面这段代码的编写
在这里插入图片描述
是不是很熟悉？平常我们编写代码的使用，经常会使用prop,ctor等快速生成代码。
那么它到底是啥呢？我们能不能自己也写一个这些的快捷生成代码的方式呢？答案是：当然可以！

2.查找代码片段文件夹

VS 中 选择【工具】，然后选择【代码片段管理器】，然后语言选择【CSharp】，如下图所示：
在这里插入图片描述
我们可以看到目录下有我们平常使用的一些快捷方式，现在我们进入上面【位置】的目录中：

C:\Program Files\Microsoft Visual Studio\2022\Enterprise\VC#\Snippets\2052\Visual C#

在这里插入图片描述
该文件夹下，就是存放代码片段的文件夹，那么我们后续自己编写的代码片段，放在这个文件夹下就可以使用了。

二、编写代码片段

1.认识代码片段

打开一个常用的for循环的snippet文件看看：
在这里插入图片描述
一个xml文档，CodeSnippet 里面主要有Header 和 Snippet。

<?xml version="1.0" encoding="utf-8"?>
<CodeSnippets xmlns="http://schemas.microsoft.com/VisualStudio/2005/CodeSnippet">
	<CodeSnippet Format="1.0.0">
		<!--Header 主要是对该快捷方式的描述-->
		<Header>
			<Title>for</Title><!--标题-->
			<Shortcut>for</Shortcut><!--这里就是定义快捷方式-->
			<Description>for 循环的代码片段</Description><!--描述文字-->
			<Author>Microsoft Corporation</Author><!--作者-->
			<SnippetTypes><!--类型-->
				<SnippetType>Expansion</SnippetType>
				<SnippetType>SurroundsWith</SnippetType>
			<SnippetType>Refactoring</SnippetType>
			<!--SnippetType 有三种：Expansion 和SurroundsWith 和Refactoring
				常用：Expansion 和SurroundsWith 
			    Expansion：允许将代码段插入到光标处。
				
				SurroundsWith：允许将此代码段放置在一段选定的代码周围。
				比如我们写完一段代码后，发现忘记加 try...catch... 了，
				这个时候可以选中需要包裹在 try...catch... 中的代码，然后调用 Code Snippet。				
			-->
			</SnippetTypes>
		</Header>
		<Snippet>
			<Declarations><!--申明变量，供Code节点使用-->
				<Literal>
					<ID>index</ID>
					<Default>i</Default>
					<ToolTip>索引</ToolTip>
				</Literal>
				<Literal>
					<ID>max</ID>
					<Default>length</Default>
					<ToolTip>最大长度</ToolTip>
				</Literal>
			</Declarations>
			<Code Language="csharp"><!--核心部分：具体代码片段展示形式-->
				<![CDATA[for (int $index$ = 0; $index$ < $max$; $index$++)
			{
			$selected$ $end$
			}]]>
			</Code>
		</Snippet>
	</CodeSnippet>
</CodeSnippets>

2.编写自定义代码片段

1、trycf (try,catch,finally)

平常使用异常捕获的时候只有try 和 tryf 但是没有try,catch,finally完整形式的捕获，我们自定义一个如下所示：

<?xml version="1.0" encoding="utf-8"?>
<CodeSnippets xmlns="http://schemas.microsoft.com/VisualStudio/2005/CodeSnippet">
	<CodeSnippet Format="1.0.0">
		<Header>
			<Title>trycf</Title>
			<Shortcut>trycf</Shortcut>
			<Description>try catch finally 的代码片段</Description>
			<Author>lzk</Author>
			<SnippetTypes>
				<SnippetType>Expansion</SnippetType>
				<SnippetType>SurroundsWith</SnippetType>
			</SnippetTypes>
		</Header>
		<Snippet>
			<Declarations>
				<Literal>
					<ID>expression</ID>
					<ToolTip>异常类型</ToolTip>
					<Function>SimpleTypeName(global::System.Exception)</Function>
				</Literal>
			</Declarations>
			<Code Language="csharp">
			<![CDATA[try 
	    {	        
		    $selected$
	    }
		catch ($expression$)
		{
			throw;
		}
	    finally
	    {
		    $end$
	    }]]>
			</Code>
		</Snippet>
	</CodeSnippet>
</CodeSnippets>

2、propp（用于MVVMLight中）

平常在我们使用MVVMLight的时候，ViewModelBase中有一个Set方法使我们实现属性通知的时候很方便，我们同样可以将其制作成代码片段。

		//使用MVVMLight框架的时候，里面属性通知有两个方法
		//【第一种方式】：RaisePropertyChanged方法
        private string phone;

        public string Phone
        {
            get { return phone; }
            set { phone = value; RaisePropertyChanged(); }
        }
		//【第二种方式】：Set方法
        private string name;

        public string Name
        {
            get { return name; }
            set { Set(ref name, value); }
        }

显然使用Set 方法代码更为简洁，具体代码片段如下：

<?xml version="1.0" encoding="utf-8"?>
<CodeSnippets xmlns="http://schemas.microsoft.com/VisualStudio/2005/CodeSnippet">
	<CodeSnippet Format="1.0.0">
		<Header>
			<Title>propp</Title>
			<Shortcut>propp</Shortcut>
			<Description>MVVMLight中具有通知功能的属性代码片段</Description>
			<Author>lzk</Author>
			<SnippetTypes>
				<SnippetType>Expansion</SnippetType>
			</SnippetTypes>
		</Header>
		<Snippet>
			<Declarations>
				<Literal>
					<ID>type</ID>
					<ToolTip>属性类型</ToolTip>
					<Default>int</Default>
				</Literal>
				<Literal>
					<ID>property</ID>
					<ToolTip>属性名</ToolTip>
					<Default>MyProperty</Default>
				</Literal>
				<Literal>
					<ID>field</ID>
					<ToolTip>支持此属性的变量</ToolTip>
					<Default>myVar</Default>
				</Literal>
			</Declarations>
			<Code Language="csharp"><![CDATA[private $type$ $field$;

	public $type$ $property$
	{
		get { return $field$;}
		set { Set(ref $field$ , value);}
	}
	$end$]]>
			</Code>
		</Snippet>
	</CodeSnippet>
</CodeSnippets>

3、ts （创建一个test方法）

平常有时候测试需要写一个临时的测试方法，如下图所示：

private void Test()
{ 
        
}

代码片段如下：

<?xml version="1.0" encoding="utf-8"?>
<CodeSnippets xmlns="http://schemas.microsoft.com/VisualStudio/2005/CodeSnippet">
	<CodeSnippet Format="1.0.0">
		<Header>
			<Title>ts</Title>
			<Shortcut>ts</Shortcut>
			<Description>测试方法的代码片段</Description>
			<Author>lzk</Author>
			<SnippetTypes>
				<SnippetType>Expansion</SnippetType>
				<SnippetType>SurroundsWith</SnippetType>
			</SnippetTypes>
		</Header>
		<Snippet>
			<Declarations>
				<Literal>
					<ID>name</ID>
					<ToolTip>测试方法名</ToolTip>
					<Default>Test</Default>
				</Literal>
			</Declarations>
			<Code Language="csharp"><![CDATA[private void $name$ ()
	{
		$selected$$end$
	}]]>
			</Code>
		</Snippet>
	</CodeSnippet>
</CodeSnippets>

4、更改propa 和propdp

当我们使用propa和propdp写依赖属性和附加属性的时候，总会生成如下代码：
在这里插入图片描述
但是原生的这两个片段有如上的缺点，因此我们做如下修改：

  • propa
<?xml version="1.0" encoding="utf-8" ?>
<CodeSnippets  xmlns="http://schemas.microsoft.com/VisualStudio/2005/CodeSnippet">
    <CodeSnippet Format="1.0.0">
        <Header>
            <Title>Define an attached DependencyProperty</Title>
            <Shortcut>propa</Shortcut>
            <Description>Code snippet for an attached property using DependencyProperty as the backing store</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>ownerclass</ID>
                    <ToolTip>The owning class of this Property.  Typically the class that it is declared in.</ToolTip>
                    <Default>ownerclass</Default>
                </Literal>
            </Declarations>
            <Code Language="csharp">
                <![CDATA[
                
public static $type$ Get$property$(DependencyObject obj)
{
    return ($type$)obj.GetValue($property$Property);
}

public static void Set$property$(DependencyObject obj, $type$ value)
{
    obj.SetValue($property$Property, value);
}

public static readonly DependencyProperty $property$Property =
    DependencyProperty.RegisterAttached("$property$", typeof($type$), typeof($ownerclass$), new PropertyMetadata(default($type$)));

$end$]]>
            </Code>
        </Snippet>
    </CodeSnippet>
</CodeSnippets>
  • propdp
<?xml version="1.0" encoding="utf-8" ?>
<CodeSnippets  xmlns="http://schemas.microsoft.com/VisualStudio/2005/CodeSnippet">
    <CodeSnippet Format="1.0.0">
        <Header>
            <Title>Define a DependencyProperty</Title>
            <Shortcut>propdp</Shortcut>
            <Description>Code snippet for a property using DependencyProperty as the backing store</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>ownerclass</ID>
                    <ToolTip>The owning class of this Property.  Typically the class that it is declared in.</ToolTip>
                    <Default>ownerclass</Default>
                </Literal>
            </Declarations>
            <Code Language="csharp">
                <![CDATA[

public $type$ $property$
{
    get { return ($type$)GetValue($property$Property); }
    set { SetValue($property$Property, value); }
}

public static readonly DependencyProperty $property$Property = 
    DependencyProperty.Register("$property$", typeof($type$), typeof($ownerclass$), new PropertyMetadata(default($type$)));

$end$]]>
            </Code>
        </Snippet>
    </CodeSnippet>
</CodeSnippets>

3.使用自定义代码片段

  • 找到C:\Program Files\Microsoft Visual Studio\2022\Enterprise\VC#\Snippets\2052\Visual C# 文件夹
  • 随便找一个snippet文件复制出来，先将原内容删除，然后将以上内容全覆盖进去，保存
  • 然后在代码片段管理器中点击【导入】按钮，将自定义的代码片段文件导入即可使用。

总结

以上就是今天要介绍的内容，希望以上内容可以帮助到大家，如文中有不对之处，还请批评指正。

鲤籽鲲
关注
  • 6
    点赞
  • 踩
  • 12
    收藏
    觉得还不错? 一键收藏
  • 1
    评论
专栏目录
dudumeijia_CodeSnippet:嘟嘟美甲的OC的代码片段
05-24
dudumeijia_OC_CodeSnippet 嘟嘟美甲的OC的代码片段
Visual Studio创建自己的代码片段
wu_pan123的博客
04-23 4010
Visual Studio创建自己的代码片段
（实用）如何在vscode设置自己的代码片段，提高开发效率
Vinca@的博客
03-08 1203
可能的变量有:$1， $2表示制表符，$0表示光标的最终位置，${1:label}， ${2:another}表示占位符,连接具有相同id的占位符。很多时候，我们新建vue文件的时，都需要把重复的代码结构重新输入或者copy过来，对开发效率照成影响。在输入框中输入 “vue” 或 “vue.json” ， 然后点击“vue.json”打开它，进行编辑。只要我们 打开过用户代码片段，vscode就会自动帮我们创建一个空白模板，存放在。前缀是用来触发代码片段的，代码体将被展开和插入。默认打开，里面附有说明。
Visual studio中C# 代码片段快捷输入和自定义代码片段
qq_39427511的博客
02-24 2511
在visual studio中输入特殊字段的关键词然后双击Tab可以输入一段完整的代码片段，能够有效的提高开发效率。如输入`if`，两次Tab，会自动生成如下的代码片段，并且光标自动定义到if的条件内，修改完成按回车键自动定位到内部。 在代码片段管理器中找到代码片段存放路径随便找一个文件复制一份，比如for代码片段for.snippet文件，在vs2022中打开。
VS好用系列之代码片段
czjnoe的博客
06-02 2931
背景： 同学们，我们后台写接口，有过没这样的困扰,每个接口都需要写这么一串相似的代码，正常都是复制粘贴一下，如下图代码所示： 那么我们有没更好、更方便快捷方法，粘贴一些固定的、常用的代码呢？ 下面介绍其中一种方法:代码片段，当然啦，还有AOP，更方便，这个以后将来有机会再讲。 public model Test() { Model model = new Model(); try { //todo } catch (Exception ex
VS Code自定义用户代码片段（C++）
Peerless__的博客
11-30 2930
vs code支持用户自定义代码片段，用起来很方便，下面来介绍一下如何使用用户代码片段 1.用户代码片段简单介绍 1.1 点击左下角设置 1.2 在cpp.json中设置要定义的代码片段`// Example: "Print to console": { "prefix": "log", "body": [ "console.log('$1');", "$2" ], "description": "Log output to console" }` 第一行字符串是一个提示信息
六、如何使用VS调试代码、条件语句
m0_66179815的博客
05-15 2187
how to use Visual Studio to debug our code 条件语句
初学者如何运用VS打代码？
qq_43657590的博客
05-20 1万+
**1.**首先进入VS（我这里以VS2017为例）如图： 2.然后选择文件–>新建–>项目 3.选择Visual C+±->空项目，为自己的项目命名，例如：我的第一个C程序；选择适当的保存路径 4.鼠标右键单击选择源文件–>添加–>新建项 5.选择C++文件，同样需要为文件命名，例如，HelloWorld.cpp;这里.cpp是C++的源文件后缀名，如果是C...
Vs code写C语言代码配置（超详细超基础）
热门推荐
记录学习路上的一些拙见
07-09 1万+
Vs code 配置，超详细贼基础，适合新热门小白，手把手教会你如何配置使用
VS新增snippets步骤
iaibeyond的专栏
05-12 335
目前遇到的一个问题，直接把自定义的snippets放在My Code Snippets路径下面，虽然可以被VS识别到，但是好像无法起作用，必须把这个snippets放在别的路径下面，然后执行导入才起作用，并且有概率无法即时起效。仿照Visual C++自带的#if，在某个位置创建一个snippet文件。4、可以在代码里使用这个snippets了，快捷键Ctrl+ K + S。3、点击导入按钮，找到我们新建的snippet文件，导入。选择My Code Snippets，点击完成。
Visual Studio自定义代码片段
xf555er的博客
03-19 703
Visual Studio提供了Code Snippet Manager功能，这使得用户可以自定义代码片段。用户可以在Code Snippet Manager中创建自己的代码片段，并指定一个唯一的提示符。一旦定义了代码片段，用户只需输入提示符，就能轻松地将其插入到代码编辑器中。使用代码片段管理器可以极大地提高编码的效率。如果你经常写重复的代码块，使用代码片段管理器就可以快速插入这些代码块，而不用每次都手动输入。代码片段管理器也可以帮助用户在不同的项目中共享代码块，从而提高团队的协作效率。
code-snippet:代码片段
05-09
代码片段 用于记录日常项目中优秀的代码块 列表 ，主要用于对echart axis的自动计算，返回interval, min, max等值。用于解决动态数据导致坐标轴部分情况下错乱的问题（当明确需要图表坐标轴固定行时）。 ，主要用于...
Code_snippet:代码片段
06-08
FullHeight 函数 addFullheight(fullh){ fullh.each(function(){ if($(this).hasClass('fullheight')){ $(this).height($(window).height()); } }) ; } FullBackground function addFullbg(fullbg){ fullbg.each...
代码片段编辑工具
11-19
.neter在编码时，敲Try 然后连按两次Tab键盘，然后VisualStudio自动帮我们补上完整try语句的代码；在这个过程中，其实Visual Studio是调用了try.snippet代码片段。我们通过此工具可以编写属于自己的代码片段
Sublime-Snippet-Collect:收集Sublime代码片段(Snippet)
05-26
下面是一些常用的代码片段收集(欢迎大家pull request) 语言 JavaScript HTML 建议使用 CSS 建议使用 框架和库 AngularJS Angular UI AngularJS Sublime Package JQuery jQuery Snippets Pack Bootstrap3 Bootstrap 3...
QT 开发COM（ActiveX）组件基础介绍和方案验证
最新发布
张坤xfiction的专栏
04-29 739
在创建组件对象时，客户程序调用COM库中的函数进行组件对象的创建工作，COM库的创建函数根据注册表的信息并调用组件程序的入口函数来创建组件对象。COM 既提供了组件之间进行交互的规范，也提供了实现交互的环境，因为组件对象之间交互的规范不依赖于任何特定的语言，所以，COM也可以是不同语言协作开发的一种标准。当另外的组件或者普通程序（即组件的客户程序）调用组件的功能时，它首先创建一个COM对象或者通过其他途径获得COM对象，然后通过该对象所实现的COM接口调用它所提供的服务。
微软如何打造数字零售力航母系列科普04 - 微软联合Adobe在微软365应用程序中工作时推出新的生成式AI功能
weixin_45278215的博客
04-29 549
我特意找了一片2018年微软零售媒体和ADOBE数字化营销技术的最初关于这个两个公司合作的官方博客。发现当今两家公司的合作，由于算法和模型的迭代，发现当前的效果已经远远高于2018年的期望。ADOBE的的强大优势在于能用数字数段，提高客户的体验和满意度。 从创意到购买的整个过程中，如果真的要做到无缝般链接来提升购买者的体验，还有很长一段路要走。最后，关于知识的democrasy, 让我想起4年前我服务的那个人工智能科技开公司的大佬们对营销部门的很多天真的想法。营销正在成为一种科技和艺术，我深信如此。
(MSFT.O)微软2024财年Q3营收619亿美元
yhqq732877的博客
04-26 735
在科技的浩渺宇宙中，一颗璀璨星辰再度闪耀其光芒——(MSFT.O)微软公司于2024财政年度第三季展现出惊人的财务表现，实现总营业收入达到令人咋舌的6190亿美元。这一辉煌成就不仅突显了微软作为全球技术领导者之一的地位，更引发了业界内外对这家巨头未来发展的无限遐想与热切期待。### 初露锋芒：业绩速览- 营收亮点：智能云服务部门功不可没，贡献显著增长动力。- 盈利引擎：“Azure和其他云业务”的快速增长成为盈利新星。- 持续创新：Office、LinkedIn及Windows 11等核心产品线持续稳健发展
xgp加速器免费 微软商店xgp用什么加速器
w2966844326的博客
04-25 811
2001年11月14日深夜，比尔·盖茨亲自来到时代广场，在午夜时分将第一台Xbox交给了来自新泽西的20岁年轻人爱德华·格拉克曼，后者在回忆中说：“比尔·盖茨就是上帝。许多的新手玩家们还找不到xgp的登录如此的繁琐，以及卡顿，小编给大家推荐一款加速器，打开迅游加速器加速XGP,体验流畅的进度。拥有十分强大的效果，最新上线的加速引擎，使我们再进行游戏的时候不再卡顿，网速超过平常的速度，这也是玩家们最想要的效果。新手玩家们务必在加速之后再使用xgp，就会发现游戏也会更加的流畅，前所未有的体验。
vscode生成代码片段
05-24
在 VS Code 中，可以使用代码片段（snippet）来快速生成常用的代码结构。以下是如何创建和使用代码片段的步骤： 1. 打开 VS Code，点击菜单栏中的 File -> Preferences -> User Snippets。 2. 选择要创建代码片段的语言类型，如果没有则选择 New Global Snippets File。 3. 在弹出的编辑器中，输入代码片段的前缀和代码内容，例如： ``` "console.log": { "prefix": "log", "body": [ "console.log($1);", "$2" ], "description": "Log output to console" } ``` 上述代码片段的前缀是 `log`，当用户在编辑器中输入 `log` 后，按下 Tab 键或者 Enter 键，就会自动插入 `console.log();` 这段代码，并将光标定位到括号内，用户可以直接输入要输出的内容。 4. 保存代码片段文件后，就可以在编辑器中使用了。在编辑器中输入代码片段的前缀，按下 Tab 键或者 Enter 键即可插入对应的代码片段。 除了手动创建代码片段外，还可以在市场中搜索和安装其他人分享的代码片段扩展。

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论 1
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值