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

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

  • Статья

Можно создать фрагмент кода с лишь несколько шагов.Все необходимо выполнить для создания XML-файлов, заполнять соответствующие элементы и добавить код к нему.Можно также добавить ссылки и параметры замены в код.Можно добавить фрагмент к установке Visual Studio с помощью кнопки импорт в code snippets manager (*** Инструменты/диспетчер фрагментов кода ***).

СоветСовет

Сведения о том, как создавать проще фрагментов кода см. на веб-сайте CodePlex для средств сообщества редактор фрагмента.

Шаблон фрагмента

Ниже приведен базовый шаблон фрагмента.

<?xml version="1.0" encoding="utf-8"?>
<CodeSnippets
    xmlns="https://schemas.microsoft.com/VisualStudio/2005/CodeSnippet">
    <CodeSnippet Format="1.0.0">
        <Header>
            <Title></Title>
        </Header>
        <Snippet>
            <Code Language="">
                <![CDATA[]]>
            </Code>
        </Snippet>
    </CodeSnippet>
</CodeSnippets>

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

  1. Создание нового XML-файла в Visual Studio и добавьте приведенный выше шаблон.

  2. Введите заголовок фрагмента, например.. «hello world», VB в элементе заголовка.

  3. Заполните язык фрагмента в атрибуте языков элемента кода.Для этого примера используйте «VB».

  4. Добавьте некоторый код в раздел CDATA внутри элемента кода, например:

    <Code Language="VB">
    <![CDATA[Console.WriteLine("Hello, World!")]]>
</Code>

  5. Сохраните фрагмент, как VBCodeSnippet.snippet.

Добавить фрагмент кода в Visual Studio

  1. Можно добавить собственные фрагменты к установке Visual Studio с использованием диспетчера фрагментов кода.Откройте диспетчер фрагментов кода (*** Инструменты/диспетчер фрагментов кода ***).

  2. Нажмите кнопку *** Импорт ***.

  3. Перейдите в расположение, где был сохранен файл фрагмента кода в предыдущей процедуре, выберите его и нажмите кнопку Открыть.

  4. Будет открыто диалоговое окно *** Импортировать фрагмент кода ***, запрашивающего, что выбран параметр где добавить фрагмент из вариантов в правой области.Один из вариантов должно быть *** Фрагменты Мой код " ***.Выделите его и нажмите кнопку *** готово ***, затем *** ОК ***.

  5. Фрагмент копируется на следующее местоположение:

    %USERPROFILE%\Documents\Visual Studio 2012\Code Snippets\Visual Basic\My Code Snippets

  6. Проверьте свой фрагмент, открыв проект Visual Basic и открыв файл кода.В *** Вставить фрагмент *** файла выберите в контекстном меню, затем *** Фрагменты Мой код " ***.Вы должны увидеть *** мой фрагмент кода Visual Basic *** с именем фрагмент.Дважды щелкните его.

  7. Вы должны увидеть Console.WriteLine("Hello, World!"), вставленное в код.

Добавление поля описание и ярлыков

  1. Поля описание получает дополнительные сведения о создаваемом фрагменте кода при просмотре в диспетчере фрагментов кода.Ярлык тег, пользователи могут ввести для вставки свой фрагмент.Правка фрагмент добавленные путем открытия %USERPROFILE%\Documents\Visual Studio 2012\Code Snippets\Visual Basic\My Code Snippet\VBCodeSnippet.snippet файла.

  2. Добавьте элементы author и описания к элементу заголовка, а их заливка.

  3. Элемент заголовка должен выглядеть примерно так:

    <Header>
    <Title>Hello World VB</Title>
    <Author>Myself</Author>
    <Description>Says Hello to the world.</Description>
</Header>

  4. Откройте диспетчер фрагментов кода и выберите свой фрагмент кода.В правой области появится, что поля описание и автора теперь будут заполнены.

  5. Добавление ярлыка добавьте элемент ярлыка рядом с элементом автора и описание:

    <Header>
    <Title>Hello World VB</Title>
    <Author>Myself</Author>
    <Description>Says Hello to the world.</Description>
    <Shortcut>hello</Shortcut>
</Header>

  6. Сохраните файл фрагмента.

  7. Чтобы проверить ярлык, откройте проект Visual Basic и откройте файл кода.Введите hello на ВКЛАДКЕ файла и давления.Код следует вставить фрагмент.

Добавление ссылок и ввозы

  1. С фрагментами Visual Basic можно добавить ссылку на проект с помощью элемента ссылки и выберите добавить объявление записей с помощью элемента записей.(Фрагменты в других языках не содержит эту функцию). Например, при изменении Console.WriteLine в примере кода в MessageBox.Show, можно добавить сборку System.Windows.Forms.dll в проект.

  2. Откройте нужный фрагмент.

  3. Добавьте элемент references под элементом фрагмента.

    <References>
    <Reference>
        <Assembly>System.Windows.Forms.dll</Assembly>
    </Reference>
</References>

  4. Добавьте элемент записей в элементе фрагмента.

    <Imports>
    <Import>
       <Namespace>System.Windows.Forms</Namespace>
    </Import>
</Imports>

  5. Измените раздел CDATA следующим образом:

    <![CDATA[MessageBox.Show("Hello, World!")]]>

  6. Сохраните фрагмент.

  7. Откройте проект Visual Basic и добавить фрагмент.

  8. Вы увидите инструкцию Imports в начале файла кода:

    Imports System.Windows.Forms

  9. Просмотрите свойства проекта.Вкладка " ссылки " включает ссылку на System.Windows.Forms.dll.

Добавление замены

  1. Может потребоваться части собственных фрагментов кода быть замещенным пользователем, например при добавлении переменную и пользователь должен заменить переменную с одним в текущем проекте.Можно предоставить 2 типа замен: литералы и объекты.Строковые литералы определенного типа (строковых литералов, имен переменных или строковых представлений числовых значений).Объекты экземпляров определенного типа, за исключением строки.В этой процедуре вы объявите литеральную замену и замену объекта и измените код для ссылки на эти замены.

  2. Откройте нужный фрагмент.

  3. Этот пример использует строку подключения SQL, поэтому необходимо изменить ввозы и ссылки на элементы, чтобы добавить соответствующие ссылки:

    <References>
    <Reference>
        <Assembly>System.Data.dll</Assembly>
    </Reference>
    <Reference>
        <Assembly>System.Xml.dll</Assembly>
    </Reference>
</References>
<Imports>
    <Import>
        <Namespace>System.Data</Namespace>
    </Import>
    <Import>
        <Namespace>System.Data.SqlClient</Namespace>
    </Import>
</Imports>

  4. Для объявления литеральную замену для строки подключения SQL добавьте элемент объявления в элементе фрагмента, и добавьте в него элемент literal с вложенные элементы для идентификатора, подсказки и значения по умолчанию для замены.

    <Declarations>
    <Literal>
        <ID>SqlConnString</ID>
        <ToolTip>Replace with a SQL connection string.</ToolTip>
        <Default>"SQL connection string"</Default>
    </Literal>
</Declarations>

  5. Объявления замену объекта для соединения SQL, добавив элемент объекта внутри элемента объявлений и добавление элементов для sub- идентификатор типа объекта, подсказки и значения по умолчанию.Полученный элемент объявлений может выглядеть следующим образом:

    <Declarations>
    <Literal>
        <ID>SqlConnString</ID>
        <ToolTip>Replace with a SQL connection string.</ToolTip>
        <Default>"SQL connection string"</Default>
    </Literal>
    <Object>
        <ID>SqlConnection</ID>
        <Type>System.Data.SqlClient.SqlConnection</Type>
        <ToolTip>Replace with a connection object in your application.</ToolTip>
        <Default>dcConnection</Default>
    </Object>
</Declarations>

  6. В разделе кода, можно ссылаться на символы замещающей с окружать $, например $replacement$:

    <Code Language="VB" Kind="method body">
    <![CDATA[Dim daCustomers As SqlDataAdapter
        Dim selectCommand As SqlCommand

        daCustomers = New SqlClient.SqlDataAdapter()
        selectCommand = new SqlClient.SqlCommand($SqlConnString$)
        daCustomers.SelectCommand = selectCommand
        daCustomers.SelectCommand.Connection = $SqlConnection$]]>
</Code>

  7. Сохраните фрагмент.

  8. Откройте проект Visual Basic и добавить фрагмент.

  9. Код должен выглядеть следующим образом, где замены строка подключения SQL и dcConnection выбранные в светлооранжевом.Нажмите клавишу TAB, чтобы перейти от одного к другому.

    Dim daCustomers As SqlDataAdapter
Dim selectCommand As SqlCommand

daCustomers = New SqlClient.SqlDataAdapter()
selectCommand = New SqlClient.SqlCommand("SQL connection string")
daCustomers.SelectCommand = selectCommand
daCustomers.SelectCommand.Connection = dcConnection

См. также

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

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