Язык

Использование фрагментов кода в Visual Studio

Фрагменты кода — это небольшие блоки кода для повторного использования, которые можно добавить в файл кода. Фрагменты обычно содержат часто используемые конструкции, такие как Try...Finally или If...Else блоки. Вы также можете использовать фрагменты кода для добавления целых классов или методов.

Фрагмент кода имеет заголовок, по которому его можно выбрать, и может иметь сокращение, которое вы вводите, чтобы вставить его. Фрагменты кода также могут содержать параметры замены, которые служат заполнителями. Visual Studio предоставляет фрагменты кода для многих языков, включая C#, C++и Visual Basic.

Необходимые условия

  • Visual Studio с поддержкой, установленной для используемого языка программирования. Доступные фрагменты зависят от установленных рабочих нагрузок и языковых компонентов.
  • Файл кода открывается в редакторе и распознается соответствующей языковой службой. В примере C++ откройте .cpp файл или .h файл.

Разберитесь в типах фрагментов

Visual Studio поддерживает два типа фрагментов кода:

  • Фрагмент расширения добавляет код в указанную точку вставки.
  • Сниппет surround-with добавляет код вокруг выделенного фрагмента кода. Обрамляющие фрагменты кода доступны только для C# и C++.

Найти доступные сниппеты

Чтобы просмотреть установленные фрагменты кода для языка, выберитедиспетчер фрагментов кода инструментов> или нажмите клавиши CTRL+K, CTRL+B. В диспетчере фрагментов кода выберите язык из списка языков .

Сведения о создании и импорте собственного фрагмента кода для отображения в списке фрагментов см . в статье Пошаговое руководство: создание фрагмента кода в Visual Studio.

Примечание.

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

Вставить фрагмент расширения

Фрагмент расширения вставляет код в точку вставки. Например, фрагмент кода C# tryf добавляет try/finally блок:

try
{

}
finally
{

}

Необходимо вставить tryf фрагмент кода, в котором действительна инструкция, например в методе, индексаторе, методе доступа к свойствам или методе доступа к событиям.

  1. В редакторе кода наведите курсор в том месте, куда вы хотите добавить сниппет.

  2. Выполните одно из следующих действий:

    • В строке меню выберите Изменить>IntelliSense>.
    • Щелкните правой кнопкой мыши и выберите Фрагмент>Вставить фрагмент.
    • Нажмите клавиши CTRL+K, CTRL+X.

  3. В окне выбора фрагментов откройте папку Visual C#, а затем дважды щелкните tryf. Вы также можете выбрать tryf и нажать клавишу TAB или ВВОД.

Блок try/finally отображается в точке вставки, готовый для настройки.

Подсказка

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

Окружите выделенный код фрагментом кода

Шаблон обрамления оборачивает выбранный код. Например, фрагмент кода C++ if упаковывает выбранную if строку return FALSE; в блок:

if (true)
{
    return FALSE;
}

Чтобы окружить выбранный код C++, выполните указанные ниже действия.

  1. В файле .cpp или .h выберите код, который требуется упаковать.

  2. Выполните одно из следующих действий:

    • В строке меню выберите Изменить>IntelliSense>Окружить фрагментом.
    • Щелкните правой кнопкой мыши и выберите Окружить.

  3. В средстве выбора фрагментов дважды щёлкните if или выберите if и нажмите Tab или Enter.

Блок if отображается вокруг выбранного кода. Замените заполнитель true условием, которое нужно вычислить.

Дополнительные примеры фрагментов кода C++ см. в фрагментах кода Visual C++.

Изменение полей замены

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

Например, фрагмент кода Visual Basic Определить свойство содержит связанные поля для вспомогательной переменной, имени свойства и типа свойства. Чтобы вставить его:

  1. В файле кода Visual Basic щелкните правой кнопкой мыши в том месте, где нужно вставить свойство, а затем выберите Фрагмент>Вставить фрагмент.
  2. Выберите шаблоны> кода, свойства, процедуры, события>,определите свойство.

Снимок экрана: средство выбора фрагмента Visual Basic с определением свойства, выбранного в разделе

Вставляется следующий код:

Private newPropertyValue As String
Public Property NewProperty() As String
    Get
        Return newPropertyValue
    End Get
    Set(ByVal value As String)
        newPropertyValue = value
    End Set
End Property

Если изменить newPropertyValue на m_property, изменятся все связанные экземпляры newPropertyValue. Если изменить тип свойства с String на Integer, каждый связанный экземпляр String изменится на Integer.

Устранение неполадок фрагментов кода

Если фрагмент или команда недоступна:

  • Убедитесь, что Visual Studio распознает файл как ожидаемый язык программирования.
  • Убедитесь, что установлен обязательный компонент рабочей нагрузки или языка.
  • Вдиспетчере фрагментов кодаинструментов> убедитесь, что фрагмент кода установлен для выбранного языка.
  • Если сочетание клавиш не работает должным образом, используйте определение и настройку сочетаний клавиш для поиска текущей привязки команды.
  • Убедитесь, что точка вставки действительна для выбранного фрагмента кода. Например, некоторые фрагменты кода C# допустимы только в объявлении метода или типа. Допустимые места вставки C# см. в разделе Фрагменты кода C#.

Проверка кода, вставленного с помощью фрагментов кода

Код фрагмента кода показывает базовый способ выполнения задачи. Просмотрите и адаптируйте созданный код перед его использованием в приложении. Рассмотрим, как код обрабатывает исключения, обращается к ресурсам, проверяет входные данные и защищает секреты.

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

В проектах .NET Framework фрагмент может использовать References элемент для добавления ссылок на проекты. Просмотрите элементы Imports и References и убедитесь, что вы доверяете указанным сборкам. Дополнительные сведения см. в разделе Импорт пространства имен и в справочнике по схеме фрагментов кода.

См. также

  • Last updated on