Visual Studio中使用代码片段(snippet)简单实例

代码片段(code-snippets)是小块可重用代码，可通过右键单击菜单（关联菜单）命令或热键组合插入到代码文件中。代码片段通常包含常用的代码块（如try-finally 或if-else 块），可用于插入整个类或方法。

使用Visual Studio2017在windows系统上的简单操作

官方文档说明：https://docs.microsoft.com/zh-cn/visualstudio/ide/code-snippets?view=vs-2017

一、创建代码片段（code-snippets）

打开Visual Studio新建一个XML文件

新建一个XML文件

在创建好的xml文件里使用鼠标右键>插入片段（或者选择“编辑” >“IntelliSense” > “插入代码段”）

插入片段

插入片段

就会生产代码片段的基本框架

snippets片段

里面的一些参数或者需要用到的参数可以查看代码片段架构参考：https://docs.microsoft.com/zh-cn/visualstudio/ide/code-snippets-schema-reference?view=vs-2017

根据需要设置需要的参数，写C#的时候我喜欢用region注释其中间的代码段有很多的重复内容就可以写一个片段

<?xml version="1.0" encoding="utf-8" ?>

<CodeSnippets xmlns="http://schemas.microsoft.com/VisualStudio/2005/CodeSnippet">

    <CodeSnippet Format="1.0.0">

        <Header>

            <Title>Code Snippet Supply</Title>

            <Shortcut>#rgEx</Shortcut>

            <Author>Yong</Author>

            <Description>region简单拓展</Description>

        </Header>

        <Snippet>

            <Code Language="CSharp">

                <![CDATA[

        #region private field

        #endregion

        #region public property

        #endregion

        #region private method

        #endregion

        #region public method

        #endregion

        #region structure method

        #endregion

        #region override

        #endregion

                ]]>

            </Code>

        </Snippet>

    </CodeSnippet>

    <!-- other snippets -->

</CodeSnippets>

主要内容都在<Snippet><Code Language="CSharp">这个节点下

二、保存代码片段

创建代码片段完成后选择文件保存（保存的文件后缀为.snippet）

snippet

三、导入代码片段

需要使用刚才创建的代码片段就得导入（“工具”菜单中打开“代码片段管理器”（或按“Ctrl+K”、“Ctrl+B”））

管理器

导入

选择导入已经保存的snippet文件，然后为代码片段选择一个位置

选择一个位置

确定导入后，就可以看到创建的代码片段了

查看

四、写点测试

在C#代码中输入快捷方式成功（因为之前的片段文件中没有设置<SnippetType>元素默认代码段可以插入到代码中的任何位置）

测试

效果