фрагменты кода visual studio
Практическое руководство. Использование окружающих фрагментов кода
Способы использования окружающих фрагментов кода описаны в процедурах ниже. Доступ к окружающим фрагментам кода можно получить тремя способами: с помощью сочетаний клавиш, меню Правка и контекстного меню.
Использование окружающих фрагментов кода с помощью сочетаний клавиш
В интегрированной среде разработки Visual Studio откройте файл, который требуется отредактировать.
В редакторе кода выделите текст, который нужно окружить.
Нажмите клавиши CTRL+K, CTRL+S.
Выберите фрагмент кода в списке фрагментов с помощью мыши или введите его имя и нажмите клавишу TAB или ВВОД.
Использование окружающих фрагментов кода с помощью меню «Правка»
В интегрированной среде разработки Visual Studio откройте файл, который требуется отредактировать.
В редакторе кода выделите текст, который нужно окружить.
В меню Правка выберите IntelliSense, а затем выберите команду Окружить.
Выберите фрагмент кода в меню вставки фрагментов кода и нажмите клавишу TAB или ВВОД.
Или можно ввести имя фрагмента кода и нажать клавишу TAB или ВВОД.
Использование окружающих фрагментов кода с помощью контекстного меню
В интегрированной среде разработки Visual Studio откройте файл, который требуется отредактировать.
В редакторе кода выделите текст, который нужно окружить.
Щелкните правой кнопкой мыши выделенный текст и в контекстном меню выберите команду Окружить.
Выберите фрагмент кода в меню вставки фрагментов кода и нажмите клавишу TAB или ВВОД.
Или можно ввести имя фрагмента кода и нажать клавишу TAB или ВВОД.
Пошаговое руководство. Создание фрагмента кода
Фрагмент кода можно создать всего в несколько шагов. Все, что необходимо сделать, — это создать XML-файл, заполнить соответствующие элементы и добавить в него код. При необходимости вы можете использовать параметры замены и ссылки на проект. Импортируйте фрагмент в папку установки Visual Studio с помощью кнопки Импорт в диспетчере фрагментов кода (Сервис > Диспетчер фрагментов кода).
Шаблон фрагмента
Ниже приведен XML-код простого шаблона фрагмента:
Создание фрагмента кода
Создайте XML-файл в Visual Studio и добавьте показанный выше шаблон.
Введите заголовок фрагмента в элементе Заголовок. Используйте заголовок Square Root (Квадратный корень).
Чтобы просмотреть все доступные значения языка, просмотрите раздел об атрибутах элементов кода на странице Справочник по схеме фрагментов кода.
Добавьте код фрагмента в раздел CDATA внутри элемента Code.
Либо для Visual Basic:
Для строк кода в разделе CDATA фрагмента кода нельзя указать отступы или форматирование. Языковая служба автоматически форматирует вставленный код.
Сохраните фрагмент как SquareRoot.snippet (его можно сохранить в любом месте).
Импорт фрагмента кода
Вы можете импортировать фрагмент в установку Visual Studio с помощью диспетчера фрагментов кода. Чтобы открыть его, выберите Сервис > Диспетчер фрагментов кода.
Нажмите кнопку Импорт.
Перейдите к папке, в которой был сохранен фрагмент кода в предыдущей процедуре, выделите его и нажмите кнопку Открыть.
Откроется диалоговое окно Импорт фрагмента кода, в котором будет предложено выбрать место добавления фрагмента (из вариантов в правой области). Один из вариантов должен быть Мои фрагменты кода. Выберите его и нажмите кнопку Готово, а затем — кнопку ОК.
В зависимости от языка кода фрагмент копируется в одно из следующих расположений:
%USERPROFILE%\Documents\Visual Studio 2017\Code Snippets\Visual C#\My Code Snippets
%USERPROFILE%\Documents\Visual Studio 2017\Code Snippets\Visual Basic\My Code Snippets
%USERPROFILE%\Documents\Visual Studio 2019\Code Snippets\Visual C#\My Code Snippets
%USERPROFILE%\Documents\Visual Studio 2019\Code Snippets\Visual Basic\My Code Snippets
Протестируйте фрагмент, открыв проект C# или Visual Basic. Открыв файл кода в редакторе, выберите пункты Фрагменты > Вставить фрагмент в контекстном меню, а затем щелкните Мои фрагменты кода. Вы должны увидеть фрагмент с именем Square Root. Дважды щелкните его.
Код фрагмента вставляется в файл кода.
Поля Description и ярлыков
Так как вы изменяете файл в том каталоге, куда его поместила система Visual Studio, вам не нужно заново импортировать его в Visual Studio.
Добавьте элементы Author и Description в элемент Header и заполните их.
Элемент Header должен выглядеть примерно так:
Откройте диспетчер фрагментов кода и выберите фрагмент кода. В правой области обратите внимание на то, что поля Description и Author теперь заполнены.
Чтобы добавить ярлык, добавьте элемент Shortcut внутрь элемента Header:
Сохраните файл фрагмента еще раз.
Чтобы протестировать ярлык, откройте использованный ранее проект, введите sqrt в редакторе и нажмите клавишу TAB (один раз для Visual Basic или два раза для C#).
Код фрагмента должен быть вставлен.
Параметры замены
Возможно, вам нужно предоставить пользователю возможность заменять части фрагмента кода. Например, может потребоваться, чтобы пользователь заменил имя переменной на используемое в текущем проекте. Возможны два типа замен: литералы и объекты. Элемент Literal используется для определения замещающего элемента для отрывка кода, который полностью заключен во фрагмент, но, скорее всего, будет изменен после вставки в код (например, строка или числовое значение). Элемент Object используется для определения элемента, который необходим во фрагменте кода, но, скорее всего, будет определен вне самого фрагмента (например, экземпляр объекта или элемент управления).
Чтобы пользователь мог легко заменить число, квадратный корень которого требуется вычислить, измените элемент Snippet в файле SquareRoot.snippet следующим образом:
Сохраните файл фрагмента.
Откройте проект и вставьте фрагмент.
После вставки фрагмента кода редактируемый литерал выделяется для замены. Наведите указатель мыши на замещающий параметр, чтобы увидеть подсказку для значения.
Если в фрагменте имеется несколько заменяемых параметров, можно нажать клавишу TAB, чтобы переходить от одного к другому для изменения значений.
Импорт пространства имен
Фрагменты кода
Этот раздел относится к Visual Studio в Windows. Информацию о Visual Studio для Mac см. в статье Фрагменты кода (Visual Studio для Mac).
Фрагменты кода доступны для различных языков, включая C#, C++, Visual Basic, XML и T-SQL. Чтобы просмотреть все доступные установленные фрагменты кода для языка, откройте Диспетчер фрагментов кода из меню Сервис (или нажмите клавиши CTRL+K, CTRL+B) и выберите требуемый язык в расположенном сверху раскрывающемся меню.
Существует несколько общих способов для обращения к фрагментам кода.
В строке меню выберите Правка > IntelliSense > Вставить фрагмент кода.
Щелкните правой кнопкой мыши или вызовите контекстное меню в редакторе кода, выберите Фрагмент кода > Вставить фрагмент кода.
На клавиатуре нажмите клавиши CTRL+K,CTRL+X.
Фрагменты расширения и фрагменты окружения
В Visual Studio существует два типа фрагментов кода: фрагменты расширения, которые добавляются в указанное курсором место и могут заменить собой ярлык фрагмента, и фрагменты окружения (только в C# и C++), которые добавляются вокруг выделенного блока кода.
Пример кода расширения. В C# ярлык TRYF служит для вставки блока TRY-FINALLY:
Пример фрагмента окружения. В C++ ярлык if может использоваться для вставки фрагмента или для добавления фрагмента обрамления. Если выбрать строку кода (например, return FALSE; ) и последовательно выбрать команды Разместить во фрагменте > if, фрагмент кода будет развернут около этой строки:
Параметры замены фрагмента кода
Фрагменты кода могут содержать параметры замены, представляющие собой заполнители, которые необходимо заменить на конкретные значения при написании кода. В предыдущем примере true — это параметр замены, который будет заменен на подходящее условие. При замене изменения повторяются для каждого вхождения одного и того же параметра в фрагменте.
Например, в Visual Basic есть фрагмент кода, который вставляет свойство. Чтобы вставить фрагмент кода, выберите Фрагмент кода. > Вставить фрагмент кода в контекстном меню в файле кода Visual Basic. Выберите Шаблоны кода > Свойства, процедуры, события > Определить свойство.
Вставлен следующий код:
Выбор фрагмента кода
В редакторе кода Visual Studio имеется средство выбора фрагментов кода, которое позволяет несколькими щелчками мыши вставлять готовые блоки кода в активный документ.
Порядок открытия средства выбора фрагмента кода зависит от используемого языка.
Visual Basic: щелкните правой кнопкой мыши в нужном месте редактора кода и в открывшемся контекстном меню выберите пункт Вставить фрагмент кода.
C#: щелкните правой кнопкой мыши в нужном месте редактора кода и в открывшемся контекстном меню выберите пункт Вставить фрагмент кода или Разместить во фрагменте.
C++: средство выбора фрагментов кода недоступно.
F#: средство выбора фрагментов кода недоступно.
JavaScript: щелкните правой кнопкой мыши в нужном месте редактора кода и в открывшемся контекстном меню выберите пункт Вставить фрагмент кода или Разместить во фрагменте.
XML — щелкните правой кнопкой мыши в нужном месте редактора кода и в открывшемся контекстном меню выберите пункт Вставить фрагмент или Разместить во фрагменте.
HTML — щелкните правой кнопкой мыши в нужном месте редактора кода и в открывшемся контекстном меню выберите пункт Вставить фрагмент или Разместить во фрагменте.
SQL — щелкните правой кнопкой мыши в нужном месте редактора кода и в открывшемся контекстном меню выберите пункт Вставить фрагмент.
В большинстве языков разработки Visual Studio можно использовать диспетчер фрагментов кода для добавления папок в список папок, в которых средство выбора фрагментов кода проверяет наличие файлов фрагментов XML. Также можно создавать собственные фрагменты кода для добавления в список. Дополнительные сведения см. в разделе Пошаговое руководство: Создание фрагмента кода.
Список элементов пользовательского интерфейса
Редактируемое текстовое поле с именем элемента, выбранного в списке элементов. Чтобы выполнить последовательный поиск нужного элемента, начните вводить его имя в этом поле. Продолжайте набирать буквы до тех пор, пока требуемый элемент не будет выбран в списке элементов.
Список фрагментов кода, доступных для вставки, или список папок с фрагментами кода. Чтобы вставить фрагмент или развернуть папку, выберите требуемый элемент и нажмите клавишу ВВОД.
Фрагменты кода
Фрагменты кода, которые часто называют шаблонами кода, удобны для эффективного программирования, так как позволяют вставлять и редактировать предварительно написанные блоки кода. Они удобны для быстрого добавления типовых шаблонов или даже для изучения новых шаблонов, когда разработчику неизвестен синтаксис. Существуют шаблоны для C#, F#, HTML, XML, Python и Razor.
Этот раздел описывает, как создавать, вставлять и использовать фрагменты кода.
Вставка фрагмента кода
Существует несколько разных способов для добавления фрагментов кода, некоторые из которых описаны ниже:
Вставка с помощью клавиши TAB. Начните вводить имя шаблона, выберите его в списке и дважды нажмите клавишу TAB, чтобы добавить его:
Панель элементов. Используйте окно «Панель элементов», чтобы отобразить список всех фрагментов кода. Перетащите любой шаблон из панели элементов в выбранное место в исходном коде:
Создание шаблона
Хотя доступно множество шаблонов для различных языков, которые вы можете использовать и изменять, можно также добавлять новые шаблоны, перейдя в раздел Visual Studio > Параметры > Текстовый редактор > Фрагменты кода:
Нажмите кнопку Добавить или Изменить, чтобы создать или изменить фрагменты кода.
Ключевые слова во фрагментах кода
Следующие поля используются для определения фрагмента кода:
Использование ключевых слов в редакторе
Чтобы использовать фрагмент с ключевыми словами, как в нашем примере, нажмите сочетание клавиш и дважды нажмите клавишу TAB, чтобы вставить содержимое фрагмента кода в позиции курсора.
Зарезервированные ключевые слова
Существует два зарезервированных ключевых слова, которые можно использовать во фрагменте:
Фрагмент кода for из предыдущего раздела иллюстрирует применение этих двух зарезервированных ключевых слов.