Acelerando a Codificação com Snippets Personalizados no Visual Studio

Acelerando a Codificação com Snippets Personalizados no Visual Studio

O Visual Studio possui uma poderosa funcionalidade para aumentar a produtividade na codificação: os code snippets.

Snippets são trechos de código prontos que podem ser inseridos rapidamente com apenas alguns cliques. O VS já vem com vários snippets pré-definidos, mas também é possível criar os seus próprios.

Por que Investir em Snippets?

Ter snippets personalizados traz diversos benefícios:

  • Economia de tempo ao evitar digitar código boilerplate manualmente
  • Padronização de código ao inserir trechos previamente definidos
  • Menos erros causados por digitação manual repetitiva
  • Compartilhamento de snippets entre times, mantendo consistência
  • Rápida inserção de código complexo de uso frequente

Criando Seu Primeiro Snippet

Criar um snippet no VS é simples. Basta seguir os passos:

  1. Ir em Ferramentas > Gerenciador de Snippets
  2. Clicar em "Novo Snippet" e definir a linguagem, como C#
  3. Dar um nome descritivo e pressionar Enter
  4. No template, digitar o código que deseja no snippet
  5. Definir pontos de inserção com $NOME$ para trechos editáveis
  6. Salvar o snippet!

Agora é só digitar o nome definido e pressionar Tab para inseri-lo.

Exemplo Prático em C#

Vamos criar um snippet para inserir um bloco try/catch em C#:

try
{
	$SELECTED$
}
catch (Exception ex)
{
	// Tratar exceção
	throw;
}        

Ao digitarmos "tryc" e pressionar Tab, esse bloco será inserido automaticamente!

Aqui está um exemplo mais completo e realista de criação e uso de um snippet funcional em C#:

Snippet para Logs em C#

Um snippet muito útil no dia a dia é um para adicionar logs de debug de forma rápida em seus métodos.

Vamos criar um snippet "log" que insere um bloco para registrar logs com a biblioteca Serilog:

<CodeSnippet Format="1.0.0">
  <Header>
    <Title>Log</Title>
  </Header>

  <Snippet>
    <Declarations>
      <Literal Editable="true">
        <ID>msg</ID>
        <ToolTip>Mensagem do log</ToolTip>
        <Default>Log message</Default>
      </Literal>
    </Declarations>

    <Code Language="csharp">
      <![CDATA[	
	_logger.LogDebug("Entering {0} method", $msg$);
	
	try 
	{
	    $selected$ 
	}
	catch (Exception ex)
	{
	   _logger.LogError(ex, "Error in {0}", $msg$); 
	   throw;
	}
	
	_logger.LogDebug("Exiting {0} method", $msg$);
      ]]>
    </Code>
  </Snippet>
</CodeSnippet>        

Ao inserir esse snippet em um método e pressionar Tab:

public void MeuMetodo()
{
  log

 // Aperte Tab aqui!

}        

Será inserido:

public void MeuMetodo()  
{
  _logger.LogDebug("Entering {0} method", "Log message");

  try
  {
      //Código do método
  }
  catch (Exception ex)
  {
     _logger.LogError(ex, "Error in {0}", "Log message");
     throw; 
  }

  _logger.LogDebug("Exiting {0} method", "Log message");

}        

Perceba como o snippet poupa o trabalho de escrever todo esse código boilerplate de logs a cada método. Os snippets podem ser simples ou mais avançados como esse. Investir neles vale muito a pena!

Compartilhando Snippets

É possível exportar snippets criados e compartilhá-los com a equipe. Assim todos podem desfrutar dos snippets personalizados.

Snippets são ótimos para agilizar a codificação diária. Invista tempo criando snippets úteis e veja sua produtividade disparar.

#visualstudio #productivity #csharp #snippets

Entre para ver ou adicionar um comentário

Outros artigos de Felipe Serra

Outras pessoas também visualizaram

Conferir tópicos