通过

Description 元素（IntelliSense 代码段）

  • 项目

更新：2007 年 11 月

指定有关 IntelliSense 代码段内容的描述信息。

<Description>
    Code Snippet Description
</Description>

属性和元素

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

属性

无。

子元素

无。

父元素

元素

说明

Header

包含有关代码段的常规信息。

文本值

需要一个文本值。

此文本指定代码段的说明。

备注

Description 元素的文本值为 代码段选择器 中的代码段提供工具提示，并为代码段管理器中的代码段提供说明。

示例

以下代码段中的 Description 元素包含值 Copies a file and saves it as another file。此说明在“代码段插入器”中作为代码段的工具提示显示，在“代码段管理器”中作为代码段的说明显示。

<CodeSnippets xmlns="https://schemas.microsoft.com/VisualStudio/2005/CodeSnippet">
   <CodeSnippet Format="1.0.0">
      <Header>
         <Title>Copy File</Title>
         <Author>Microsoft Corporation</Author>
         <Description>Copies a file and saves it as another file.</Description>
         <HelpUrl>www.microsoft.com</HelpUrl>
         <SnippetTypes>
            <SnippetType>Expansion</SnippetType>
         </SnippetTypes>
         <Keywords>
             <Keyword>File copying</Keyword>
             <Keyword>Copying files</Keyword>
         </Keywords>
         <Shortcut>copyfile</Shortcut>
      </Header>
      <Snippet>
         <!-- Insert snippet information here -->
      </Snippet>
   </CodeSnippet>
</CodeSnippets>

请参见

概念

代码段架构参考