Header, élément (extraits de code IntelliSense)

Article
08/10/2011

Spécifie des informations générales sur l'extrait de code IntelliSense.

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

Attributs et éléments

Les sections suivantes décrivent des attributs, des éléments enfants et des éléments parents.

Attributs

Aucun

Éléments enfants

Élément	Description
Author	Élément facultatif. Nom de la personne ou de la société qui a créé l'extrait de code. Il peut y avoir zéro ou un élément Author dans un élément Header.
Description	Élément facultatif. Description de l'extrait de code. Il peut y avoir zéro ou un élément Description dans un élément Header.
HelpURL	Élément facultatif. URL contenant plus d'informations sur l'extrait de code. Il peut y avoir zéro ou un élément HelpURL dans un élémentHeader.
Mots clés	Élément facultatif. Groupe les éléments Keyword. Il peut y avoir zéro ou un élément Keywords dans un élémentHeader.
Raccourci	Élément facultatif. Spécifie le texte du raccourci qui peut être utilisé pour insérer l'extrait de code. Il peut y avoir zéro ou un élément Shortcut dans un élémentHeader.
SnippetTypes	Élément facultatif. Groupe des éléments SnippetType. Il peut y avoir zéro ou un élément SnippetTypes dans un élément Header. S'il n'y a pas d'éléments SnippetTypes, l'extrait de code est toujours valide.
Titre	Élément requis. Nom convivial de l'extrait de code. Un élément Header doit contenir exactement un élément Title.

Éléments parents

Élément	Description
CodeSnippet	Élément parent pour toutes les données d'extrait de code.

Exemple

Le code suivant montre comment définir les valeurs des éléments enfants d'un élément Header.

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

Voir aussi

Concepts

Référence de schéma des extraits de code

Partager via