通过

Code 元素（IntelliSense 代码段）

  • 项目

为 IntelliSense 代码段的短代码块提供一个容器。

<Code Language="Language"
    Kind="method body/method decl/type decl/page/file/any"
    Delimiter="Delimiter">
    Code to insert
</Code>

特性和元素

以下几节描述了特性、子元素和父元素。

特性

特性

描述

Delimiter

可选特性。

指定用于描述代码中的文本和对象的分隔符。 默认分隔符为 $。

Kind

可选特性。

指定代码段包含的代码的种类，以及编译代码段时代码段应插入的位置。 可用的值有 method body、method decl、type decl、file 和 any。 有关更多信息，请参见下表中的“Kind 特性”部分。

Language

必需的特性。

指定代码段的语言。 有关更多信息，请参见一节“语言特性”。

Kind 特性

值

描述

method body

指定代码段为方法体，因此必须插入到方法声明中。

method decl

指定代码段为方法，因此必须插入到类或模块中。

type decl

指定代码段为类型，因此必须插入到类、模块或命名空间中。

file

指定代码段为完整的代码文件。 这些代码段可单独插入到代码文件或命名空间中。

any

指定代码段可以插入到任何位置。 此标记可用于上下文独立的代码段，如注释。

语言特性

值

描述

VB

用于标识 Visual Basic 代码段。

CSharp

用于标识 Visual C# 代码段。

XML

用于标识 XML 代码段。

CPP

标识 c. c++ 代码段。

JavaScript

标识 JavaScript 代码段。

JScript

标识 Jscript 代码段。

SQL

标识的 SQL 代码段。

HTML

用于标识 HTML 代码段。

子元素

无。

父元素

元素

描述

Snippet

包含用于代码段的引用、导入、声明和代码。

文本值

需要一个文本值。

此文本用于指定在将此代码段插入到项目中时可以使用的代码以及文本和对象。

备注

两个保留的单词可在 Code 元素的文本中使用：$end$ 和 $selected$。 $end$ 标记在插入代码段之后用于放置光标的位置。 $selected$ 表示在文档中选择的要在调用时插入代码段的文本。 例如，如果您具有：

$selected$ is a great color. I love $selected$.

并且词语“Blue”在调用模板时已选定，则您将获得：

Blue is a great color. I love Blue.

所有其他 $ 关键字将在 <Literal> 和 <Object> 标记中自动定义。

示例

以下代码段的 Code 元素演示如何编写创建 SqlDataAdapter 的 Visual C# 代码段。 在 Code 元素中，可按文本和对象的 ID 元素值引用 Declarations 元素中定义的文本和对象。 在此示例中，文本作为 $SQL$ 引用，而对象作为 $Connection$ 引用。

<CodeSnippets xmlns="https://schemas.microsoft.com/VisualStudio/2005/CodeSnippet">
    <CodeSnippet Format="1.0.0">
        <Header>
            <Title>Create a data adapter</Title>
            <Description>Creates a SqlDataAdapter object.</Description>
            <Author>Microsoft Corporation</Author>
            <Shortcut>createadapter</Shortcut>
        </Header>
        <Snippet>
            <Declarations>
                <Literal>
                    <ID>SQL</ID>
                    <ToolTip>Replace with a SQL connection string.</ToolTip>
                    <Default>"SQL connection string"</Default>
                </Literal>
                <Object>
                    <ID>Connection</ID>
                    <Type>System.Data.SqlClient.SqlConnection</Type>
                    <ToolTip>Replace with a connection object in your application.</ToolTip>
                    <Default>dcConnection</Default>
                </Object>
            </Declarations>
            <Code Language="CSharp">
                <![CDATA[
                    daCustomers = new SqlClient.SqlDataAdapter();
                    selectCommand = new SqlClient.SqlCommand($SQL$);
                    daCustomers.SelectCommand = selectCommand;
                    daCustomers.SelectCommand.Connection = $Connection$;
                ]]>
            </Code>
        </Snippet>
    </CodeSnippet>
</CodeSnippets>

请参见

概念

代码段架构参考