演练：创建代码段

项目
02/23/2013

可以用只有几个步骤创建代码段。您需要做的所有工作是创建XML文件，填充适当的元素和代码添加到它。还可以添加引用和替换参数添加到您的代码。您可以将该代码段添加到您的Visual Studio安装使用在代码段管理器(*** 工具/代码段管理器 ***)的导入按钮。

提示

有关如何编写代码段更轻松地的信息，请搜索CodePlex网站社区工具编辑代码段(如。

代码段模板

下面是基本代码段模板:

<?xml version="1.0" encoding="utf-8"?>
<CodeSnippets
    xmlns="https://schemas.microsoft.com/VisualStudio/2005/CodeSnippet">
    <CodeSnippet Format="1.0.0">
        <Header>
            <Title></Title>
        </Header>
        <Snippet>
            <Code Language="">
                <![CDATA[]]>
            </Code>
        </Snippet>
    </CodeSnippet>
</CodeSnippets>

创建代码段

创建一个新XML文件在Visual Studio中添加显示的模板中。
填充该代码段的标题，即.. “hello world” VB，在title元素。
填充代码段的语言中代码元素的语言特性的。对于此示例，请使用“VB”。

例如添加在CDATA节中的某些代码元素内，例如:

<Code Language="VB">
    <![CDATA[Console.WriteLine("Hello, World!")]]>
</Code>

保存此代码段作为VBCodeSnippet.snippet。

添加代码段到Visual Studio

使用代码段管理器，您可以添加自己的代码段添加到您的Visual Studio安装。打开代码段管理器(*** 工具/代码段管理器 ***)。
单击 *** 导入 *** 按钮。
转到您保存前面过程中的代码段，选择该文件，然后单击打开的位置。
*** 导入代码段 *** 对话框在何处打开，要求您选择从在右窗格中选择添加此代码段。之一选择应是 *** 我的代码段 ***。选择并单击 *** 完成 ***，然后 *** 好 ***。
此代码段复制到以下位置:

%USERPROFILE%\Documents\Visual Studio 2012\Code Snippets\Visual Basic\My Code Snippets
通过打开Visual Basic项目并打开代码文件测试您的代码段。在上下文菜单的文件 *** 插入代码段 *** 单击，然后 *** 我的代码段 ***。您应看到名为 ***** 我的Visual Basic代码段 *****的代码段。双击它。
您应看到在代码中插入的 Console.WriteLine("Hello, World!")。

添加标题和快捷字段

说明字段在代码段管理器提供有关您的代码段的更多信息，请查看。快捷键用户可以键入以插入自己的代码段的标记。编辑可以通过打开文件添加了 %USERPROFILE%\Documents\Visual Studio 2012\Code Snippets\Visual Basic\My Code Snippet\VBCodeSnippet.snippet的代码段。
添加作者和图例元素到标头元素，并将它们。

标头元素应类似于:

<Header>
    <Title>Hello World VB</Title>
    <Author>Myself</Author>
    <Description>Says Hello to the world.</Description>
</Header>

打开代码段管理器并选择您的代码段。在右窗格中应看到声明和作者字段现在已被填充。

若要添加快捷键，请添加沿着作者和声明元素的一个shortcut元素:

<Header>
    <Title>Hello World VB</Title>
    <Author>Myself</Author>
    <Description>Says Hello to the world.</Description>
    <Shortcut>hello</Shortcut>
</Header>

再次保存代码段文件。
测试快捷方式，打开Visual Basic项目并打开代码文件。键入在文件并按选项的您好。应插入代码段。

若要添加引用和导入

通过使用import元素，Visual Basic代码段可以添加对项目使用引用元素，并添加导入声明。 (在其他语言的代码段没有此功能。)例如，因此，如果更改了代码示例中的 Console.WriteLine 到 MessageBox.Show，您可能需要添加System.Windows.Forms.dll程序集添加到项目中。
打开您的代码段。

添加对元素在代码段元素下:

<References>
    <Reference>
        <Assembly>System.Windows.Forms.dll</Assembly>
    </Reference>
</References>

添加导入元素在代码段元素下:

<Imports>
    <Import>
       <Namespace>System.Windows.Forms</Namespace>
    </Import>
</Imports>

更改CDATA节为以下代码:

<![CDATA[MessageBox.Show("Hello, World!")]]>

保存此代码段。
打开Visual Basic项目并添加此代码段。
您将看到语句导入到代码文件顶部:
```
Imports System.Windows.Forms
```
查看项目的属性。引用选项包括对System.Windows.Forms.dll。

添加替换

例如，如果您将一个变量并希望用户在一个替换变量在当前项目中，您可以自己的代码段的部分由用户替换。可以提供替换的两种类型：文本和对象。文本是某些类型(字符串、变量名或数值字符串表示形式字符串)。除了字符串之外，Objects是某些类型的实例。在此过程中声明文本替换和对象替换，并将代码引用这些替换。
打开您的代码段。

此示例使用SQL连接字符串，因此，您需要更改导入和引用元素添加适当的引用:

<References>
    <Reference>
        <Assembly>System.Data.dll</Assembly>
    </Reference>
    <Reference>
        <Assembly>System.Xml.dll</Assembly>
    </Reference>
</References>
<Imports>
    <Import>
        <Namespace>System.Data</Namespace>
    </Import>
    <Import>
        <Namespace>System.Data.SqlClient</Namespace>
    </Import>
</Imports>

若要声明SQL连接字符串的文本替换，请将声明元素在代码段元素和在其中添加具有子元素的文本元素ID、工具提示和默认的替换的:

<Declarations>
    <Literal>
        <ID>SqlConnString</ID>
        <ToolTip>Replace with a SQL connection string.</ToolTip>
        <Default>"SQL connection string"</Default>
    </Literal>
</Declarations>

若要声明SQL连接的对象替换，请将声明元素内的某个对象元素，并添加ID的子元素，对象的类型，工具提示和默认值。发生的声明元素应如下所示:

<Declarations>
    <Literal>
        <ID>SqlConnString</ID>
        <ToolTip>Replace with a SQL connection string.</ToolTip>
        <Default>"SQL connection string"</Default>
    </Literal>
    <Object>
        <ID>SqlConnection</ID>
        <Type>System.Data.SqlClient.SqlConnection</Type>
        <ToolTip>Replace with a connection object in your application.</ToolTip>
        <Default>dcConnection</Default>
    </Object>
</Declarations>

在代码段，使用引用包围$符号，如 $replacement$的替换:

<Code Language="VB" Kind="method body">
    <![CDATA[Dim daCustomers As SqlDataAdapter
        Dim selectCommand As SqlCommand

        daCustomers = New SqlClient.SqlDataAdapter()
        selectCommand = new SqlClient.SqlCommand($SqlConnString$)
        daCustomers.SelectCommand = selectCommand
        daCustomers.SelectCommand.Connection = $SqlConnection$]]>
</Code>

保存此代码段。
打开Visual Basic项目并添加此代码段。

代码应如下所示，其中替换 SQL连接字符串和 dcConnection 在淡桔色显示。 tab键从一个到另一个导航。

Dim daCustomers As SqlDataAdapter
Dim selectCommand As SqlCommand

daCustomers = New SqlClient.SqlDataAdapter()
selectCommand = New SqlClient.SqlCommand("SQL connection string")
daCustomers.SelectCommand = selectCommand
daCustomers.SelectCommand.Connection = dcConnection

请参见

概念

代码段架构参考