Description-Element (IntelliSense-Codeausschnitte)

Artikel
09/03/2008

Aktualisiert: November 2007

Liefert beschreibende Informationen über den Inhalt eines IntelliSense-Codeausschnitts.

<Description>
    Code Snippet Description
</Description>

Attribute und Elemente

In den folgenden Abschnitten werden Attribute, untergeordnete Elemente und übergeordnete Elemente beschrieben.

Attribute

Keine

Untergeordnete Elemente

Keine

Übergeordnete Elemente

Element	Beschreibung
Header	Enthält allgemeine Informationen über einen Codeausschnitt.

Textwert

Ein Textwert ist erforderlich.

Dieser Text stellt eine Beschreibung eines Codeausschnitts dar.

Hinweise

Der Textwert des Description-Elements stellt eine QuickInfo für den Codeausschnitt im Codeausschnittsauswahl sowie die Beschreibung des Codeausschnitts im Codeausschnitt-Manager bereit.

Beispiel

Das Description-Element im folgenden Codeausschnitt enthält den Wert Copies a file and saves it as another file. Diese Beschreibung wird im Codeausschnitteinfüger als QuickInfo zum Codeausschnitt sowie im Codeausschnitt-Manager als Beschreibung zum Codeausschnitt angezeigt.

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

Siehe auch

Konzepte

Schemareferenz für Codeausschnitte

Freigeben über