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

Статья
08/11/2011

Задает ссылки, импорты, объявления и код для фрагмента кода.

<Snippet>
    <References>... </References>
    <Imports>... </Imports>
    <Declarations>... </Declarations>
    <Code>... </Code>
</Snippet>

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

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

Атрибуты

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

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

Элемент	Описание
Код	Обязательный элемент. Задает код, который требуется вставить в файл документации. Элемент Snippet должен содержать только один элемент Code.
Объявления	Необязательный элемент. Задает литералы и объекты, которые составляют части фрагмента кода, доступные для редактирования. Элемент Snippet может содержать один элемент Declarations или ни одного такого элемента.
Imports	Необязательный элемент. Группирует отдельные элементы Import. Элемент Snippet может содержать один элемент Imports или ни одного такого элемента.
Ссылки	Необязательный элемент. Группирует отдельные элементы Reference. Элемент Snippet может содержать один элемент References или ни одного такого элемента.

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

Элемент	Описание
CodeSnippet	Позволяет задать заголовок и несколько фрагментов кода IntelliSense, которые могут быть вставлены в файлы кода Visual Studio.

Пример

В следующем коде показано, как использовать элемент Snippet и его дочерние элементы для написания фрагмента кода Visual C#, создающего объект SqlDataAdapter.

<CodeSnippets xmlns="https://schemas.microsoft.com/VisualStudio/2005/CodeSnippet">
    <CodeSnippet Format="1.0.0">
        <Header>
            <Title>Create a data adapter</Title>
            <Description>Creates a SqlDataAdapter object.</Description>
            <Author>Microsoft Corporation</Author>
            <Shortcut>createadapter</Shortcut>
        </Header>
        <Snippet>
            <Declarations>
                <Literal>
                    <ID>SQL</ID>
                    <ToolTip>Replace with a SQL connection string.</ToolTip>
                    <Default>"SQL connection string"</Default>
                </Literal>
                <Object>
                    <ID>Connection</ID>
                    <Type>System.Data.SqlClient.SqlConnection</Type>
                    <ToolTip>Replace with a connection object in your application.</ToolTip>
                    <Default>dcConnection</Default>
                </Object>
            </Declarations>
            <Code Language="CSharp">
                <![CDATA[
                    daCustomers = new SqlClient.SqlDataAdapter();
                    selectCommand = new SqlClient.SqlCommand($SQL$);
                    daCustomers.SelectCommand = selectCommand;
                    daCustomers.SelectCommand.Connection = $Connection$;
                ]]>
            </Code>
        </Snippet>
    </CodeSnippet>
</CodeSnippets>

См. также

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

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

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