Criando e utlizando Code Snippets no Visual Studio

Neste artigo vamos aprender como criar e usar Code Snippets no Visual Studio

Olá desenvolvedores, neste artigo vamos aprender a desenvolver e utilizar Code Snippets no Visual Studio.

O que é um Code Snippet ?
Code Snippet é um recurso muito interessante do Visual Studio, com ele podemos acessar blocos de códigos pré definidos anteriormente em um arquivo XML, por padrão o VS já traz alguns Code Snippets pré definidos, como If, Else, For, entre outros. Com este recurso podemos acelerar muito o nosso desenvolvimento e utilização de nossas classes.

  Clique no "Ler mais" e veja o tutorial completo

No primeiro instante vamos entender na prática o que é um Code Snippet, abra seu Visual Studio e crie um novo projeto "Web Site" como mostra a imagem abaixo.

Agora vamos ver como identificar um Code Snippet, vá ao codebehind e digite um if no page load, o ícone de um Code snippet é um bloquinho de notas com linhas azuis como mostra a imagem abaixo.

Se você deixar o Code Snippet selecionado na lista do IntelliSense e apertar duas vezes Tab o bloco de código completo do If é gerado automaticamente com o cursor parado na parte da condição, não, ele não adivinha onde é o local que você vai modificar, isto é um arquivo XML com extensão .snippet previamente definido anteriormente, agora vamos aprender como desenvolver nossos próprios Code Snippets e instala-lo em nosso Visual Studio.

Esta é a estrutura básica de um Code Snippet, veja o código abaixo:

<?xml version="1.0" encoding="utf-8" ?>
<CodeSnippets  xmlns="http://schemas.microsoft.com/VisualStudio/2005/CodeSnippet">
  <CodeSnippet Format="1.0.0">
    <Header>
<!-- Aqui definimos o titulo do nosso Code Snippet -->
      <Title>Declara Int e String</Title>
<!-- Aqui definimos o atalho que vamos usar -->
      <Shortcut>IntString</Shortcut>
<!--Aqui definimos a descrição do Code Snippet-->
      <Description>Adiciona variavel do tipo int e string.</Description>
      <SnippetTypes>
        <SnippetType>SurroundsWith</SnippetType>
      </SnippetTypes>
    </Header>
    <Snippet>
      <Declarations>
<!-- Aqui definimos quais as variaveis que serão editaveis -->
        <Literal>
<!-- Aqui definimos o id da variavel -->
          <ID>NomeI</ID>
<!-- Aqui definimos o valor padrao da variavel -->
          <Default>intVariavel</Default>
<!-- Aqui definimos o tooltip da variavel -->
          <ToolTip>Nome da variavel int</ToolTip>
        </Literal>
        
        <Literal>
          <ID>NomeS</ID>
          <Default>sTeste</Default>
          <ToolTip>Nome da variavel string</ToolTip>
        </Literal>
          
      </Declarations>
<!-- Aqui definimos qual o tipo do código que pertence este CS -->
      <Code Language="csharp">
<!-- Aqui definimos o código que será gerado -->
<!-- Note que as variáveis que declaramos anteriormente estão -->
<!-- entre cifrões $ -->
        <![CDATA[     
          int $NomeI$;
          string $NomeS$;
          $end$
        ]]>
      </Code>
    </Snippet>
  </CodeSnippet>
</CodeSnippets>

Note que é um arquivo ultra simples, salve ele em um arquivo com extensão .snippet e salve em alguma pasta.
Agora vamos aprender como chamar este arquivo no Visual Studio, siga as instruções abaixo.

Vá no menu superior no Visual Studio e selecione o item Tools, depois clique em Code Snippets Manager.

Após feito isto selecione a linguagem que vai adicionar o Code Snippet no item Linguage e clique em Add, selecione a pasta e clique em ok, pronto nosso CS está adicionado ao Visual Studio e pronto para ser utilizado.

Vamos testar, vá ao Codebehind e digita o Shortcut definido anteriormente no arquivo XML.

Simples não, deixe seleciondo nosso Code no IntelliSense e aperte duas vezes Tab, pronto, nosso código perfeitamente criado como foi definido, para navegar entre as variáveis aperte Tab, se existir duas variáveis com o mesmo nome no Code Snippet editando um o outro é alterado automaticamente, muito lega, bom lição passada, até a próxima.