Header (Elemento, fragmentos de código IntelliSense)

Artículo
10/07/2008

Actualización: noviembre 2007

Especifica información general sobre el fragmento de código de IntelliSense.

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

Atributos y elementos

En las siguientes secciones se describen los atributos, elementos secundarios y elementos primarios.

Atributos

Ninguno

Elementos secundarios

Elemento	Descripción
Author	Elemento opcional. El nombre de la persona o compañía que creó el fragmento de código. Puede haber cero o un elemento Author en un elemento Header.
Description	Elemento opcional. Descripción del fragmento de código. Puede haber cero o un elemento Description en un elemento Header.
HelpURL	Elemento opcional. Dirección URL que contiene más información sobre el fragmento de código. Puede haber cero o un elemento HelpURL en un elemento Header.
Keywords	Elemento opcional. Agrupa los elementos Keyword. Puede haber cero o un elemento Keywords en un elemento Header.
Shortcut	Elemento opcional. Especifica el texto de acceso directo que se puede utilizar para insertar el fragmento. Puede haber cero o un elemento Shortcut en un elemento Header.
SnippetTypes	Elemento opcional. Agrupa los elementos SnippetType. Puede haber cero o un elemento SnippetTypes en un elemento Header. Si no hay ningún elemento SnippetTypes, el fragmento de código siempre es válido.
Title	Elemento necesario. Nombre descriptivo del fragmento de código. Debe haber exactamente un elemento Title en un elemento Header.

Elementos primarios

Elemento	Descripción
CodeSnippet	Elemento principal para todos los datos del fragmento de código.

Ejemplo

El código siguiente muestra cómo establecer los valores de los elementos secundarios de un elemento 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>

Vea también

Conceptos

Referencia de esquemas de fragmentos de código

Compartir a través de