如何:创建基本代码段

IntelliSense 代码段是文件扩展名为 .snippet 的 XML 文件,符合 IntelliSense 代码段 XML 架构。 在本主题中,您将创建显示消息框的基本代码段。 有关代码段 XML 架构的更多信息,请参见 代码段架构参考

创建代码段文件

若要创建代码段文件,必须创建一个 XML 文件,然后编写组成代码段的 XML 代码。 有关下面的示例中使用的任何 XML 元素的更多信息,请参见 代码段架构参考

创建代码段文件

  1. 创建一个 XML 文件,然后在编辑器中打开该文件。

  2. 在自动生成的 XML 行下,添加一个具有相应 xmlns 特性值的 CodeSnippets 元素,以及一个用于创建单个代码段的 CodeSnippet 元素。 例如:

    <CodeSnippets xmlns="https://schemas.microsoft.com/VisualStudio/2005/CodeSnippet">
        <CodeSnippet Format="1.0.0">
    
  3. 向代码段中添加标头部分。 例如:

    <Header>
        <Title>
            My Snippet
        </Title>
    </Header>
    
  4. 添加用于定义代码段本身的元素。 在下面的示例中,代码段的语言为 Visual Basic。

    <Snippet>
        <Code Language="VB">
    
        </Code>
    </Snippet>
    

    提示

    Language 特性还接受以下类型的值:CSharpVJSharpXML。 有关更多信息,请参见Code 元素(IntelliSense 代码段)

  5. Code 元素内部,为代码段添加 Visual Basic 代码。 所有的代码段都必须置于 <![CDATA[ 与 ]]> 括号之间。 在下面的示例中,将插入的代码为 MessageBox.Show("Hello World")。

    <Code Language="VB">
        <![CDATA[MessageBox.Show("Hello World")]]>
    </Code>
    
  6. Snippet 元素内部,添加 References 元素以及插入代码段时向项目中添加引用所必需的所有子元素。 在此示例中,插入代码段时,该代码段会添加对 System.Windows.Forms.dll 的引用。

    提示

    只有 Visual Basic 代码段支持 References 节。 其他语言中的代码段需要手动添加正确的引用。

    <Snippet>
        <References>
            <Reference>
                <Assembly>System.Windows.Forms.dll</Assembly>
            </Reference>
        </References>
        <Code Language="VB">
            <![CDATA[MessageBox.Show("Hello World")]]>
        </Code>
    </Snippet>
    
  7. 从**“文件”菜单中,单击“<文件名> 另存为…”**,并使用 .snippet 扩展名保存该文件。

可以按照如何:管理代码段如何:插入 IntelliSense 代码段中的过程,在 Visual Studio 中使用此 IntelliSense 代码段。

示例

此示例包含在前面的步骤中创建的整个 IntelliSense 代码段。

<CodeSnippets
    xmlns="https://schemas.microsoft.com/VisualStudio/2005/CodeSnippet">
    <CodeSnippet Format="1.0.0">
        <Header>
            <Title>
                My Snippet
            </Title>
        </Header>
        <Snippet>
            <References>
                <Reference>
                    <Assembly>System.Windows.Forms.dll</Assembly>
                </Reference>
            </References>
            <Code Language="VB">
                <![CDATA[MessageBox.Show("Hello World")]]>
            </Code>
        </Snippet>
    </CodeSnippet>
</CodeSnippets>

此示例包含在前面的步骤中创建的 IntelliSense 代码段的 Visual C# 版本。 Visual C# 代码段不支持 References 节,因此必须向项目中手动添加对 System.Windows.Forms.dll 的引用。

<CodeSnippets
    xmlns="https://schemas.microsoft.com/VisualStudio/2005/CodeSnippet">
    <CodeSnippet Format="1.0.0">
        <Header>
            <Title>
                My Snippet
            </Title>
        </Header>
        <Snippet>
            <Code Language="CSharp">
                <![CDATA[MessageBox.Show("Hello World");]]>
            </Code>
        </Snippet>
    </CodeSnippet>
</CodeSnippets>

请参见

参考

创建代码段

创建和使用 IntelliSense 代码段

概念

代码段架构参考