如何：创建基本代码段

更新：2007 年 11 月

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

创建 .snippet 文件

开始编写代码段之前，必须先创建一个文件扩展名为 .snippet 的 XML 文件。

创建 .snippet 文件

1. 在“文件”菜单上单击“新建”，再单击“文件”。

2. 单击“XML 文件”，再单击“打开”。

3. 在“文件”菜单上单击“保存 <XMLFileName>”。

4. 在“保存类型”框中选择“所有文件(*.*)”。

5. 在“文件名”框中，输入文件扩展名为 .snippet 的文件名。

6. 单击“保存”。

编写代码

既然已具有 XML 文件，则需要编写组成代码段的 XML 代码。有关下面的示例中使用的任何 XML 元素的更多信息，请参见 代码段架构参考。

为代码段编写代码

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

   <CodeSnippets xmlns="https://schemas.microsoft.com/VisualStudio/2005/CodeSnippet">
       <CodeSnippet Format="1.0.0">
   

2. 向代码段中添加标头部分。例如：

   <Header>
       <Title>
           My Snippet
       </Title>
   </Header>
   

3. 添加用于定义代码段本身的元素。在下面的示例中，代码段的语言为 Visual Basic。

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

   说明：
   Language 属性还接受以下类型的值：CSharp、VJSharp 和 XML。有关更多信息，请参见Code 元素（IntelliSense 代码段）。

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

   <Code Language="VB">
       <![CDATA[MessageBox.Show("Hello World")]]>
   </Code>
   

5. 在 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>
   

现在可以按照如何：管理代码段和如何：插入 IntelliSense 代码段中的过程，在 Visual Studio 2005 中使用此 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>

此示例包含在前面的步骤中创建的 Visual C# 版本的 IntelliSense 代码段。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 代码段