Blog do Cazelli

Melhor do que poder usar os code snippets que o Visual Studio nos oferece é poder construir os nossos próprios, podendo agilizar a digitação de códigos que usamos com frequência. Antes de continuar lendo eu recomendo ler este outro tutorial que mostra rapidamente como utilizar-los.

Os snippets do são nada mais do que arquivos xml com a extensão ‘.snippet’. Para este tutorial usar a estrutura abaixo como exemplo:

if (!String.IsNullOrEmpty(Request.QueryString["Argumento"]))
{

}

Para gerar um snippet com este formato temos que usar o seguinte xml:

01.<?xml version="1.0" encoding="utf-8" ?>
02.<CodeSnippets  xmlns="http://schemas.microsoft.com/VisualStudio/2005/CodeSnippet">
03.	<CodeSnippet Format="1.0.0">
04.		<Header>
05.			<Title>QueryString</Title>
06.			<Shortcut>QueryString</Shortcut>
07.			<SnippetTypes>
08.				<SnippetType>SurroundsWith</SnippetType>
09.			</SnippetTypes>
10.		</Header>
11.		<Snippet>
12.			<Declarations>
13.				<Literal>
14.					<ID>Argumento</ID>
15.					<Default>Argumento</Default>
16.				</Literal>
17.			</Declarations>
18.			<Code Language="csharp"><![CDATA[if
(!String.IsNullOrEmpty(Request.QueryString["$Argumento$"]))
19.	{
20.		$selected$ $end$
21.	}]]>
22.			</Code>
23.		</Snippet>
24.	</CodeSnippet>
25.</CodeSnippets>

Explicando o xml:

• Na linha 5 temos o nome do o snippet, e na seguinte temos o texto que você terá que digitar para que o ele apareça, ou seja, quando você começar a digitar “QueryString”  ele aparecerá na lista.
• Na linha 13 temos a abertura da tag <Literal>, ela é responsável por declarar os elementos editáveis. Para cada novo elemento deve-se colocar novamente esta tag com seus filhos <ID> e <Default>, sendo o primeiro usado mais a frente para identificar o elemento no código, o segundo é o texto que irá aparecer para ser substituído.
• Na linha 18 começa o código do nosso snippet. O código deve sempre estar entre  “<![CDATA[“ e “]]>”. Note que nesta linha temos uma declaração “$Argumento$” esta declaração é a que foi feita mais acima na tag literal.
• Ainda na linha 18 temos a declaração da propriedade “Lamguage” que diz ao Visual Studio a qual linguagem de programação o snippet pertence.
• Na linha 20 temos duas declarações importantes. A primeira, “$selected$”, diz respeito ao lugar que o código ficará no caso do uso do snippet como  ”surrounds with”. A segunda diz respeito de para onde o cursor irá quando terminarmos a edição dos elementos.

Agora que temos o nosso código pronto basta adiciona-lo no Visual Studio. Para isso vá ao menu “Tools” e depois em “Code Snippet Manager”. Na janela que abrirá temos as opções de adicionar um único snippet em “Add” ou adicionar uma pasta inteira em “Import”. Também temos que selecionar a linguagem correspondente em “Language”.

Adicionando Code Snippet

A minha dica é manter os  snippets para facilitar o backup quando necessário. Para baixar este exemplo clique aqui.