Header-Element (IntelliSense-Codeausschnitte)

Liefert allgemeine Informationen zum IntelliSense-Codeausschnitt.

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

Attribute und Elemente

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

Attribute

Keine.

Untergeordnete Elemente

Element

Beschreibung

Autor

Optionales Element

Der Name der Person oder der Firma, die den Codeausschnitt erstellt hat. Ein Header-Element kann kein oder ein Author-Element enthalten.

Description

Optionales Element.

Eine Beschreibung des Codeausschnitts. Ein Header-Element kann kein oder ein Description-Element enthalten.

HelpURL

Optionales Element.

Eine URL, die weitere Informationen über den Codeausschnitt enthält. Ein Header-Element kann kein oder ein HelpURL-Element enthalten.

Schlüsselwörter

Optionales Element.

Gruppiert Keyword-Elemente. Ein Header-Element kann kein oder ein Keywords-Element enthalten.

Shortcut

Optionales Element.

Gibt den Verknüpfungstext an, der zum Einfügen des Ausschnitts verwendet werden kann. Ein Header-Element kann kein oder ein Shortcut-Element enthalten.

SnippetTypes

Optionales Element.

Gruppiert SnippetType-Elemente. Ein Header-Element kann kein oder ein SnippetTypes-Element enthalten. Wenn keine SnippetTypes-Elemente verfügbar sind, ist der Codeausschnitt immer gültig.

Titel

Erforderliches Element.

Der benutzerfreundliche Name des Codeausschnitts. Es muss genau ein Title-Element in einem Header-Element vorhanden sein.

Übergeordnete Elemente

Element

Beschreibungen

CodeSnippet

Übergeordnetes Element für alle Codeausschnittdaten.

Beispiel

Im folgenden Code wird veranschaulicht, wie die Werte der untergeordneten Elemente eines Header-Elements festgelegt werden.

<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