代码段架构参考

IntelliSense 代码段是预编写的代码段，你可以随时使用 Visual Studio 将这些代码段插入到你的应用程序中。 可以通过提供代码段来减少键入重复代码或搜索示例所用的时间，从而提高工作效率。 可以使用 IntelliSense 代码段 XML 架构创建自己的代码段，并将它们添加到 Visual Studio 已包含的代码段中。

IntelliSense 代码段架构元素

Assembly 元素

指定代码段引用的程序集的名称。

Assembly 元素的文本值可以是程序集的友好文本名称（如 System.dll），也可以是程序集的强名称（如 System,Version=1.0.0.1,Culture=neutral,PublicKeyToken=9b35aa323c18d4fb1）。

<Assembly>
    AssemblyName
</Assembly>

需要一个文本值。 此文本指定代码段引用的程序集。

Author 元素

指定代码段作者的姓名。 代码段管理器显示存储在代码段的 Author 元素中的代码段名称。

<Author>
   Code Snippet Author
</Author>

需要一个文本值。 此文本指定代码段的作者。

Code 元素

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

两个保留字可在 Code 元素的文本中使用：$end$ 和 $selected$。 $end$ 标记在插入代码段之后用于放置光标的位置。 $selected$ 表示在文档中选择的要在调用时插入代码段的文本。 例如，指定一个代码段，使其包括：

$selected$ is a great color.

如果用户在调用模板时选择了“蓝色”一词，结果为：

Blue is a great color.

你不能在一个代码段中多次使用 $end$ 或 $selected$。 如果要这么做，只能识别第二个实例。 指定代码段，使其包括：

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

如果选择了“蓝色”一词，结果为：

 is a great color. I love Blue.

由于 $selected$ 和 is 之间存在空格，所以出现了初始空格。

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

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

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

CodeSnippet 元素

允许你指定一个标题和多个 IntelliSense 代码段，你可以将其插入 Visual Studio 代码文件中。

<CodeSnippet Format="x.x.x">
    <Header>... </Header>
    <Snippet>... </Snippet>
</CodeSnippet>

CodeSnippets 元素

对 CodeSnippet Element 元素进行分组。 CodeSnippets 元素是代码段 XML 架构的根元素。

<CodeSnippets>
    <CodeSnippet>... </CodeSnippet>
</CodeSnippets>

Declarations 元素

指定作为某个代码段组成部分的文本和对象，你可以对该代码段进行编辑。

<Declarations>
    <Literal>... </Literal>
    <Object>... </Object>
</Declarations>

Default 元素

指定 IntelliSense 代码段的文本或对象的默认值。

<Default>
    Default value
</Default>

需要一个文本值。 此文本指定文本或对象的默认值，该默认值用于填充你可以编辑的代码段的字段。

Description 元素

指定有关 IntelliSense 代码段内容的说明信息。

<Description>
    Code Snippet Description
</Description>

需要一个文本值。 此文本描述代码段。

Function 元素

指定当 Visual Studio 中的文本或对象收到焦点时要执行的函数。

<Function>
    FunctionName
</Function>

需要一个文本值。 此文本指定当文本或对象字段在 Visual Studio 中获得焦点时要执行的函数。

Header 元素

指定有关 IntelliSense 代码段的常规信息。

<Header>
    <Title>... </Title>
    <Author>... </Author>
    <Description>... </Description>
    <HelpUrl>... </HelpUrl>
    <SnippetTypes>... </SnippetTypes>
    <Keywords>... </Keywords>
    <Shortcut>... </Shortcut>
</Header>

HelpUrl 元素

指定一个用于提供有关代码段的详细信息的 URL。

<HelpUrl>
    www.microsoft.com
</HelpUrl>

文本值是可选的。 此文本指定用于访问有关代码段的详细信息的 URL。

ID 元素

指定 Literal 或 Object 元素的唯一标识符。 在同一代码段中，两个文本或对象不能在其 ID 元素中拥有相同文本值。文本和对象不能包含具有末尾值的 ID 元素。 $end$ 值是保留值，用于标记插入代码段后放置光标的位置。

<ID>
    Unique Identifier
</ID>

需要一个文本值。 此文本指定对象或文本的唯一标识符。

Import 元素

指定 IntelliSense 代码段使用的导入的命名空间。

<Import>
    <Namespace>... </Namespace>
</Import>

Imports 元素

对单个 Import 元素进行分组。

<Imports>
    <Import>... </Import>
<Imports>

Keyword 元素

为代码段指定自定义关键字。 代码段关键字由 Visual Studio 使用，这些关键字表示联机内容提供程序添加用于搜索或分类的自定义关键字的标准方法。

<Keyword>
    Code Snippet Keyword
</Keyword>

需要一个文本值。 代码段的关键字。

Keywords 元素

对单个 Keyword 元素进行分组。 代码段关键字由 Visual Studio 使用，这些关键字表示联机内容提供程序添加用于搜索或分类的自定义关键字的标准方法

<Keywords>
    <Keyword>... </Keyword>
    <Keyword>... </Keyword>
<Keywords>

Literal 元素

定义你可以编辑的代码段的文本。 Literal 元素用于标识整体包含在代码段中、但在插入到代码中后可能会进行自定义的代码部分的替换对象。 例如，文本字符串、数值和某些变量名应声明为文本。

文本和对象不能包含具有选定值或末尾值的 ID 元素。 值 $selected$ 表示在文档中选择的要在调用时插入代码段的文本。 $end$ 标记在插入代码段之后用于放置光标的位置。

<Literal Editable="true/false">
   <ID>... </ID>
   <ToolTip>... </ToolTip>
   <Default>... </Default>
   <Function>... </Function>
</Literal>

Namespace 元素

指定使代码段能够正常编译和运行而必须导入的命名空间。 如果尚不存在命名空间，系统会将 Namespace 元素中指定的命名空间自动添加到代码起始位置处的 Imports 语句中。

<Namespace>
    Namespace
</Namespace>

需要一个文本值。 此文本指定代码段采用的命名空间已导入。

Object 元素

定义你可以编辑的代码段的对象。 Object 元素用于标识代码段所需的、但可能是在代码段外部定义的项。 例如，Windows 窗体控件、ASP.NET 控件、对象实例以及类型实例应声明为对象。 对象声明要求指定类型，这一操作可通过 Type 元素完成。

<Object Editable="true/false">
    <ID>... </ID>
    <Type>... </Type>
    <ToolTip>... </ToolTip>
    <Default>... </Default>
    <Function>... </Function>
</Object>

Reference 元素

指定有关代码段所需的程序集引用的信息。

<Reference>
    <Assembly>... </Assembly>
    <Url>... </Url>
</Reference>

References 元素

对单个 Reference 元素进行分组。

<References>
    <Reference>... </Reference>
</References>

Shortcut 元素

指定用于插入代码段的快捷方式文本。 Shortcut 元素的文本值只能包含字母数字字符、连字符 (-) 和下划线 (_)。

<Shortcut>
    Shortcut Text
</Shortcut>

文本值是可选的。 此文本可作为插入代码段的快捷方式使用。

Snippet 元素

指定代码段的引用、导入、声明和代码。

<Snippet>
    <References>... </References>
    <Imports>... </Imports>
    <Declarations>... </Declarations>
    <Code>... </Code>
</Snippet>

SnippetType 元素

指定 Visual Studio 如何插入代码段。

<SnippetType>
    SurroundsWith/Expansion
<SnippetType>

此文本值必须为以下值之一：

• SurroundsWith：允许将代码段放置在一段选定的代码周围。

• Expansion：允许将代码段插入到光标处。

• Refactoring：指定在 Visual C# 重构过程中使用代码段。 不能在自定义代码段中使用 Refactoring。

SnippetTypes 元素

对单个 SnippetType 元素进行分组。 如果 SnippetTypes 元素不存在，则代码段可以插入到代码中的任何位置。

<SnippetTypes>
    <SnippetType>... </SnippetType>
    <SnippetType>... </SnippetType>
<SnippetTypes>

Title 元素

指定代码段的标题。 代码段的 Title 元素中存储的标题显示在代码段选择器中和代码段管理器的代码段说明中。

<Title>
    Code Snippet Title
<Title>

需要一个文本值。 此文本指定代码段的标题。

ToolTip 元素

描述代码段中文本或对象的所需值和用法，Visual Studio 将代码段插入项目时将在工具提示中显示这些内容。 插入代码段后，当鼠标悬停在文本或对象上时，将显示工具提示文本。

<ToolTip>
    ToolTip description
</ToolTip>

需要一个文本值。 此文本指定要与代码段中的对象或文本关联的工具提示说明。

Type 元素

指定对象的类型。 Object 元素用于标识代码段所需的、但可能是在代码段外部定义的项。 例如，Windows 窗体控件、ASP.NET 控件、对象实例以及类型实例应声明为对象。 对象声明要求指定类型，这一操作可通过 Type 元素完成。

<Type>
    Type
</Type>

需要一个文本值。 此文本指定对象的类型。

Url 元素

指定一个 URL，它提供有关所引用程序集的详细信息。

<Url>
    www.microsoft.com
</Url>

需要一个文本值。 此文本指定包含有关所引用程序集的详细信息的 URL。 在无法向项目添加引用时将显示此 URL。

请参见

任务

演练：创建代码段

其他资源

代码段