Visual Studio C#: создание фрагментов кода IntelliSense (snippets)

В начале стоит определиться что такое snippet и для чего они нужны.

Проще говоря, snippet – это шаблон (заготовка) кода, например определение свойства, определение метода, определение класса и т.д. При вставке фрагмента кода, например Exception, IntelliSense позволяет не только получить шаблон, но и автоматически выполняет изменение однотипных элементов, например имя класса.

Как работать со сниппетами? Для этого доступно несколько вариантов:

1. набрать известное имя сниппета и нажать tab;
2. нажать сочетание клавиш Ctrl+k+x для вывода списка всех зарегистрированных сниппетов;
3. использовать контекстное меню, выбрав вставить фрагмент или разметить фрагмент.

Первый вариант наиболее удобен (при наличии знаний о snippet-ах IntelliSense): можно набрать, к примеру «prop», нажать tab и мгновенно получить шаблонное определение свойства класса. Вполне естественно, что такой механизм чрезвычайно полезен. Он экономит время, позволяя определять заранее отформатированный код с возможностью удобной кастомизации. Возможно, это никак не повлияет на работу вашей программы, но добавит вам некоторую порцию удовольствия от процесса кодирования. Еще больше пользы можно получить делая свои сниппеты.

Где расположены snippet-ы?

Расположение снипетов для языка C#, поставляемых в составе Visual Studio:

C:Program Files (x86)Microsoft Visual Studio 14.0VC#Snippets1049Visual C#

Расположение снипетов, разрабатываемых самостоятельно, для языка C# :

%USERPROFILE%DocumentsVisual Studio 2015Code SnippetsVisual C#My Code Snippets

Создание снипетов

В составе Visual Studio при разработке консольного приложения есть snippet для формирования строки Console.WriteLine(), но при этом отсутствует snippet например для публикования Console.ReadLine(). Чтобы исправить это досадное недоразумение, в качестве примера, создадим файл cr.snippet со следующим кодом:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22

<CodeSnippets xmlns="http://schemas.microsoft.com/VisualStudio/2005/CodeSnippet">
	<CodeSnippet Format="1.0.0">
		<Header>
			<Title>cr</Title>
			<Shortcut>cr</Shortcut>
			<Description>Фрагмент кода для Console.ReadLine</Description>
			<Author>Сергей</Author>
			<SnippetTypes>
				<SnippetType>Expansion</SnippetType>
			</SnippetTypes>
		</Header>
		<Snippet>
			<Declarations>
				<Literal Editable="false">
					<ID>SystemConsole</ID>
					<Function>SimpleTypeName(global::System.Console)</Function>
				</Literal>
			</Declarations>
			<Code Language="csharp"><![CDATA[$SystemConsole$.ReadLine($end$);]]></Code>
		</Snippet>
	</CodeSnippet>
</CodeSnippets>

Интеграция снипетов

Для интеграции разработанного фрагмента кода в среду Visual Studio можно поступить одни из следующих способов.

1. Поместить созданный файл файл в папку My Code Snippets и Visual Studio мгновенно отреагирует на его появление.
2. Перейти в главное меню Сервис -> Диспетчер фрагментов кода, в открывшемся окне указать в какой раздел сохранить сниппет и нажав кнопку Импорт. После этого можно  набрать сочетание cr в редакторе Visual Studio  и нажать tab:

Таким же образом был создан snippet для Console.ReadKey() который на скриншоте выше называется crk.

Немного опишем структуру снипетов

Итак, что же представляет собой описание данного сниппета. Основные тэги следующие: Header, который содержит описательную часть, и Snippet, который содержит логику.

Более детальное описание дочерних тэгов Header:

Более детальное описание дочерних тэгов Snippet:

В подразделе Snippet декларируются литералы, значение которых можно будет редактировать при использовании сниппета, и собственно код сниппета. Обратите внимание на то, как определяется литерал: указывается его идентификатор, подсказка и значение по умолчанию. Идентификатор литерала затем используется в теле кода сниппета. Для выделения литерала, он заключается между двумя знаками доллара «$».

Тэг Code содержит кроме определения кода сниппета еще и несколько атрибутов: Language, который указывает на целевой язык сниппета и может принимать значения VB, CSharp, VJSharp, или XML; Delimiter, который позволяет переопределить знак доллара на другой символ; и Kind, который позволяет указать сферу применения сниппета и принимает значения «method body», «method decl», «type decl», file, или any.

В заключение

Для того чтобы ознакомиться со всеми доступными фрагментами кода Visual Studio, необходим перейти в главном меню Сервис -> Диспетчер фрагментов кода. Необходимо выбрать язык программирования, в моем случае CSharp. В строке расположение будут указаны пути к файлам snippet, поэтому всегда можно открыть нужный файл и взять его за основу для разрабатываемого фрагмента кода (snippet-а).

Подробнее почитать можно здесь:

https://msdn.microsoft.com/ru-ru/library/ms171418.aspx

https://msdn.microsoft.com/ru-ru/library/ms165394.aspx

https://msdn.microsoft.com/en-US/library/ms379562?f=255&MSPPError=-2147217396