Практическое руководство. Создание простого фрагмента кода

Статья
11/05/2008

Обновлен: Ноябрь 2007

Фрагменты кода IntelliSense являются XML-файлами с расширением .snippet, соответствующими схеме XML фрагмента кода IntelliSense. В этом разделе рассматривается создание простого фрагмента кода, отображающего окно сообщения. Дополнительные сведения о схеме XML фрагмента кода см. в разделе Справочник по схеме фрагментов кода.

Создание файла с расширением .snippet

Прежде чем приступить к написанию фрагмента кода необходимо создать XML-файл с расширением .snippet.

Создание файла с расширением .snippet

В меню Файл укажите пункт Создать, а затем выберите пункт Файл.
Щелкните XML-файл и нажмите кнопку Открыть.
В меню "Файл" выберите пункт Сохранить <XMLFileName>.
В поле Тип файла выберите Все файлы (*.*).
В поле Имя файла введите имя файла с расширением .snippet.
Нажмите Сохранить.

Написание кода

Теперь, когда имеется файл XML, необходимо написать код XML, который составит фрагмент кода. Дополнительные сведения об любых элементах XML, использованных в приведенных ниже примерах, смотрите в разделе Справочник по схеме фрагментов кода.

Написание кода для фрагмента кода

Чтобы создать отдельный фрагмент кода, под автоматически созданной строкой XML-кода добавьте элемент CodeSnippets с соответствующим значением атрибута xmlns и элемент CodeSnippet. Например:
```
<CodeSnippets xmlns="https://schemas.microsoft.com/VisualStudio/2005/CodeSnippet">
    <CodeSnippet Format="1.0.0">
```
Добавьте верхний колонтитул к фрагменту кода. Например:
```
<Header>
    <Title>
        My Snippet
    </Title>
</Header>
```

Добавьте элементы, определяющие сам фрагмент кода. В следующем примере для фрагмента кода выбран язык Visual Basic.

<Snippet>
    <Code Language="VB">

    </Code>
</Snippet>

Примечание.
Атрибут Language также принимает значения CSharp, VJSharp и XML. Дополнительные сведения см. в разделе Элемент Code (фрагменты кода IntelliSense).

В элемент Code добавьте код Visual Basic для фрагмента. Весь фрагмент кода должен быть заключен в скобки <![CDATA[ и ]]>. В следующем примере вставляемым кодом будет MessageBox.Show("Hello World").
```
<Code Language="VB">
    <![CDATA[MessageBox.Show("Hello World")]]>
</Code>
```

При вставке фрагмента в элемент Snippet добавьте элемент References и все обязательные дочерние элементы, добавляющие ссылку на проект. В этом примере при вставке фрагмент кода добавляет ссылку на System.Windows.Forms.dll.

Примечание.
Раздел References поддерживается только фрагментами кода Visual Basic. Для других языков фрагментов кода правильные ссылки следует добавить вручную.

<Snippet>
    <References>
        <Reference>
            <Assembly>System.Windows.Forms.dll</Assembly>
        </Reference>
    </References>
    <Code Language="VB">
        <![CDATA[MessageBox.Show("Hello World")]]>
    </Code>
</Snippet>

Теперь можно использовать этот фрагмент кода IntelliSense в Visual Studio 2005, следуя инструкциям разделов Практическое руководство. Управление фрагментами кода и Практическое руководство. Вставка фрагментов кода IntelliSense.

Пример

В следующем примере содержится созданный в предыдущих шагах фрагмент кода IntelliSense целиком.

<CodeSnippets
    xmlns="https://schemas.microsoft.com/VisualStudio/2005/CodeSnippet">
    <CodeSnippet Format="1.0.0">
        <Header>
            <Title>
                My Snippet
            </Title>
        </Header>
        <Snippet>
            <References>
                <Reference>
                    <Assembly>System.Windows.Forms.dll</Assembly>
                </Reference>
            </References>
            <Code Language="VB">
                <![CDATA[MessageBox.Show("Hello World")]]>
            </Code>
        </Snippet>
    </CodeSnippet>
</CodeSnippets>

В примере ниже содержится версия Visual C# фрагмента кода IntelliSense, созданная в предыдущих шагах. Фрагменты кода Visual C# не поддерживают раздел References, следовательно ссылку на System.Windows.Forms.dll в проект необходимо добавить вручную.

<CodeSnippets
    xmlns="https://schemas.microsoft.com/VisualStudio/2005/CodeSnippet">
    <CodeSnippet Format="1.0.0">
        <Header>
            <Title>
                My Snippet
            </Title>
        </Header>
        <Snippet>
            <Code Language="CSharp">
                <![CDATA[MessageBox.Show("Hello World");]]>
            </Code>
        </Snippet>
    </CodeSnippet>
</CodeSnippets>