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


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

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

Создание SNIPPET-файла

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

Создание файла фрагмента кода

  1. Создайте XML-файл и откройте его в редакторе.

  2. Чтобы создать отдельный фрагмент кода, под автоматически созданной строкой XML-кода добавьте элемент CodeSnippets с соответствующим значением атрибута xmlns и элемент CodeSnippet. Пример.

    <CodeSnippets xmlns="https://schemas.microsoft.com/VisualStudio/2005/CodeSnippet">
        <CodeSnippet Format="1.0.0">
    
  3. Добавьте верхний колонтитул к фрагменту кода. Пример.

    <Header>
        <Title>
            My Snippet
        </Title>
    </Header>
    
  4. Добавьте элементы, определяющие сам фрагмент кода. В следующем примере для фрагмента кода выбран язык Visual Basic.

    <Snippet>
        <Code Language="VB">
    
        </Code>
    </Snippet>
    

    Примечание

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

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

    <Code Language="VB">
        <![CDATA[MessageBox.Show("Hello World")]]>
    </Code>
    
  6. При вставке фрагмента в элемент 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>
    
  7. В меню Файл выберите пункт Сохранить имя_файла как... и сохраните файл как SNIPPET-файл.

Теперь этот фрагмент кода IntelliSense можно использовать в Visual Studio, следуя указаниям разделов Практическое руководство. Управление фрагментами кода и Практическое руководство. Вставка фрагментов кода 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>

См. также

Ссылки

Создание фрагментов кода

Создание и использование фрагментов кода IntelliSense

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

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