Partilhar via


Elemento Description (trechos de código de IntelliSense)

Especifica a informação descritiva sobre o conteúdo de um trecho de código IntelliSense.

<Description>
    Code Snippet Description
</Description>

Atributos e elementos

As seções a seguir descrevem elementos filho, atributos, e elementos pai.

Atributos

Nenhum.

Elementos filho

Nenhum.

Elementos pai

Elemento

Descrição

Cabeçalho

Contém informações gerais sobre um trecho de código.

Valor de texto

Um valor de texto é necessário.

Esse texto especifica uma descrição de um trecho de código.

Comentários

O valor de texto do elemento de Description fornece uma dica de ferramenta para o trecho de código em Selecionador de trecho de código e uma descrição para o trecho de código em Gerenciador de Trechos de Código.

Exemplo

O elemento de Description no seguinte trecho de código contém o valor Copies a file and saves it as another file.Esta como ela aparecerá a dica de ferramenta de trecho de código em Inserter de trecho de código e a descrição de trecho de código em O gerenciador de trecho de código.

<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>

Consulte também

Conceitos

Referência de esquema de trechos de código