Literal 元素
定义你可以编辑的代码段的文本。 该 Literal
元素标识完全包含在代码片段中的代码片段的替换项,该代码片段可在插入代码段后进行自定义。 例如,文本字符串、数值和某些变量名应声明为文本。
文本和对象不能包含 ID
值为 selected
或 end
. 该值 $selected$
表示在调用代码段时要插入代码片段的选定文档文本。 $end$
标记在插入代码段之后用于放置光标的位置。
<Literal Editable="true/false">
<ID>... </ID>
<ToolTip>... </ToolTip>
<Default>... </Default>
<Function>... </Function>
</Literal>
特性 | 说明 |
---|
编辑 | 可选的 Boolean 特性。 指定在插入代码段之后是否可以编辑文本。 此特性的默认值为 true 。 |
子元素 | 描述 |
---|
Default 元素 | 必需 元素。 指定插入代码段时文本的默认值。 Default 元素中必须有且仅有一个 Literal 元素。 |
Function 元素 | 可选元素。 指定当文本在 Visual Studio 中获得焦点时要执行的函数。 元素中可能有零个或一个Function Literal 元素。 |
ID 元素 | 必需 元素。 指定文本的唯一标识符。 ID 元素中必须有且仅有一个 Literal 元素。 |
ToolTip 元素 | 可选元素。 描述文本的预期值和用法。 元素中可能有零个或一个ToolTip Literal 元素。 |
父元素 | 描述 |
---|
Declarations 元素 | 包含代码段的可编辑文本和对象。 |
Namespace 元素
指定使代码段能够正常编译和运行而必须导入的命名空间。 如果尚不存在命名空间,系统会将 Namespace
元素中指定的命名空间自动添加到代码起始位置处的 using
指令或 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>
属性 | 说明 |
---|
编辑 | 可选的 Boolean 特性。 指定在插入代码段之后是否可以编辑文本。 此特性的默认值为 true 。 |
子元素 | 描述 |
---|
Default 元素 | 必需 元素。 指定插入代码段时文本的默认值。 Default 元素中必须有且仅有一个 Literal 元素。 |
Function 元素 | 可选元素。 指定当文本在 Visual Studio 中获得焦点时要执行的函数。 元素中可能有零个或一个Function Literal 元素。 |
ID 元素 | 必需 元素。 指定文本的唯一标识符。 ID 元素中必须有且仅有一个 Literal 元素。 |
ToolTip 元素 | 可选元素。 描述文本的预期值和用法。 元素中可能有零个或一个ToolTip Literal 元素。 |
Type 元素 | 必需 元素。 指定对象的类型。 Type 元素中必须有且仅有一个 Object 元素。 |
父元素 | 描述 |
---|
Declarations 元素 | 包含代码段的可编辑文本和对象。 |
Reference 元素
指定有关代码段所需的程序集引用的信息。
<Reference>
<Assembly>... </Assembly>
<Url>... </Url>
</Reference>
子元素 | 描述 |
---|
Assembly 元素 | 必需 元素。 包含代码段引用的程序集的名称。 Assembly 元素中必须有且仅有一个 Reference 元素。 |
Url 元素 | 可选元素。 包含一个提供有关所引用程序集的详细信息的 URL。 元素中可能有零个或一个Url Reference 元素。 |
父元素 | 描述 |
---|
References 元素 | 对 Reference 元素进行分组。 |
References 元素
对单个 Reference
元素进行分组。
<References>
<Reference>... </Reference>
</References>
子元素 | 描述 |
---|
Reference 元素 | 可选元素。 包含有关代码段的程序集引用的信息。 Reference 元素中可能有零个或零个以上的 References 元素。 |
父元素 | 描述 |
---|
Snippet 元素 | 包含用于代码段的引用、导入、声明和代码。 |
Shortcut 元素
指定用于插入代码段的快捷方式文本。 元素的文本值 Shortcut
只能包含字母数字字符和下划线(_
)。
备注
C++ 代码片段快捷方式不支持下划线 (_
) 字符。
<Shortcut>
Shortcut Text
</Shortcut>
父元素 | 描述 |
---|
Header 元素 | 包含有关代码段的常规信息。 |
文本值是可选的。 此文本可作为插入代码段的快捷方式使用。
Snippet 元素
指定代码段的引用、导入、声明和代码。
<Snippet>
<References>... </References>
<Imports>... </Imports>
<Declarations>... </Declarations>
<Code>... </Code>
</Snippet>
子元素 | 描述 |
---|
Code 元素 | 必需 元素。 指定要插入到文档文件中的代码。 Code 元素中必须有且仅有一个 Snippet 元素。 |
Declarations 元素 | 可选元素。 指定作为某个代码段组成部分的文本和对象,你可以对该代码段进行编辑。 元素中可能有零个或一个Declarations Snippet 元素。 |
Imports 元素 | 可选元素。 对单个 Import 元素进行分组。 元素中可能有零个或一个Imports Snippet 元素。 |
References 元素 | 可选元素。 对单个 Reference 元素进行分组。 元素中可能有零个或一个References Snippet 元素。 |
父元素 | 描述 |
---|
CodeSnippet 元素 | 允许你指定一个标题和多个代码段,你可以将其插入 Visual Studio Code 文件中。 |