Como criar Code Snippets no Visual Studio 2013

  • Article

No artigo Code Snippets no Visual Studio 2013 fiz uma introdução sobre o que são os code snippets e de como utiizar os pré-definidos no Visual Studio 2013.

Nesse artigo, vou mostrar como criar novos code snippets.

O primeiro passo é criar um arquivo XML e salvá-lo com a extensão .snippet, por exemplo, AddMyDemoClass.snippet.

O seguinte template pode ser utilizado para definir o conteúdo do arquivo:

<?xml version="1.0" encoding="utf-8"?>

<CodeSnippets xmlns="https://schemas.microsoft.com/VisualStudio/2005/CodeSnippet">

  <CodeSnippet Format="1.0.0">

    <Header>

      <Title> </Title>

      <Author></Author>

      <Description></Description>

      <Shortcut></Shortcut>

    </Header>

    <Snippet>

      <Code Language="">

       <![CDATA[]]></Code>

    </Snippet>

  </CodeSnippet>

</CodeSnippets>

 

O atributo Title define o título do code snippet. Por exemplo, podemos preencher com o texto Criar a classe MyDemoClass.

O atributo shortcut define qual é a palavra que irá inserir o fragmento de código no projeto. Por exemplo, nesse caso o shortcut poderia ser addMyDemoClass.

 

O elemento Language define para qual linguagem o snippet está sendo criado. Para VB.NET utilize VB e para C# utilize csharp.

 

O fragmento de código deve ser informado dentro da sessão CDATA, conforme:

<Code Language="csharp">
    <![CDATA[public class MyDemoClass
{
    public int ID {get;set;}
} ]>
</Code>

Para adicionar o code snippet no Visual Studio, siga os seguintes passos:

  1. Abra o Gerenciador de Trechos de Código (Tools/Code Snippets Manager).

  2. Clique no botão Import.

  3. Vá para o local onde você salvou o trecho de código no procedimento anterior, selecione-o e clique em Open.

  4. A caixa de diálogo Import Code Snippet será aberta, solicitando que você escolha onde adicionar o snippet. Uma das opções deve ser My Code Snippets. Selecione e clique em Finish, e então em OK.

  5. O trecho é copiado para o seguinte local:

    %USERPROFILE%\Documents\Visual Studio 2013\Code Snippets\Visual C#\My Code Snippets

 

Para testar, abra ou crie um projeto na mesma linguagem em que o seu code snippet foi criado e digite o shortcut definido no XML. No nosso exemplo, se digitarmos addMyDemoClass e pressionarmos duas vezes o Tab, o VS irá substituir a palavra addMyDemoClass pelo código:

 public class MyDemoClass
{
public int ID { get; set; }
}

 

Para maiores detalhes veja o artigo: https://msdn.microsoft.com/en-us/library/ms165394.aspx

O artigo Extensão para criar Code Snippets descreve como utilizar uma extensão para facilitar a criação e edição dos code snippets.