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

Статья
08/11/2011

Определяет описание содержания фрагмента кода IntelliSense.

<Description>
    Code Snippet Description
</Description>

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

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

Атрибуты

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

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

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

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

Элемент	Описание
Заголовок	Содержит общие сведения о фрагменте кода.

Текстовое значение

Текстовое значение является обязательным.

Данный текст определяет описание фрагмента кода.

Заметки

Текстовое значение элемента Description предоставляет всплывающую подсказку для фрагмента кода в выбор фрагмента кода и описание фрагмента кода в Диспетчер фрагментов кода.

Пример

Элемент Description в следующем фрагменте кода содержит значение Copies a file and saves it as another file. Данное описание отображается в виде всплывающей подсказки для фрагмента кода в меню вставки фрагментов и в виде описания фрагмента кода в диспетчере фрагментов кода.

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

См. также

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

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

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