Элемент Header (фрагменты кода IntelliSense)

Статья
08/11/2011

Задает общие сведения о фрагменте кода IntelliSense.

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

Атрибуты и элементы

В следующих разделах описаны атрибуты, дочерние и родительские элементы.

Атрибуты

Отсутствует.

Дочерние элементы

Элемент	Описание
Author	Необязательный элемент. Имя человека или компании, которые являются автором фрагмента кода. Элемент Header может содержать один элемент Author или ни одного такого элемента.
Описание	Необязательный элемент. Описание фрагмента кода. Элемент Header может содержать один элемент Description или ни одного такого элемента.
HelpURL	Необязательный элемент. URL-адрес, содержащий дополнительные сведения о фрагменте кода. Элемент Header может содержать один элемент HelpURL или ни одного такого элемента.
Ключевые слова	Необязательный элемент. Группирует элементы Keyword. Элемент Header может содержать один элемент Keywords или ни одного такого элемента.
Ярлык	Необязательный элемент. Задает сокращенное имя, которое может использоваться для вставки фрагмента. Элемент Header может содержать один элемент Shortcut или ни одного такого элемента.
SnippetTypes	Необязательный элемент. Группирует элементы SnippetType. Элемент Header может содержать один элемент SnippetTypes или ни одного такого элемента. При отсутствии элементов SnippetTypes фрагмент кода остается действителен.
Название	Обязательный элемент. Понятное имя фрагмента кода. Элемент Header должен содержать только один элемент Title.

Родительские элементы

Элемент	Описание
CodeSnippet	Родительский элемент для всех данных фрагмента кода.

Пример

В следующем коде показано, как задать значения дочерних элементов элемента 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>

См. также

Основные понятия

Справочник по схеме фрагментов кода

Поделиться через