Snippets de código

Snippets de código, geralmente chamados de modelos de código, são úteis para obter uma programação eficiente, já que permitem a inserção e a edição de blocos de código previamente escritos. O uso de snippets de código pode ser conveniente para adicionar rapidamente padrões comuns ou até mesmo para conhecer novos padrões quando, como desenvolvedor, você não tiver certeza sobre a sintaxe. Há modelos fornecidos para C#, F#, HTML, XML, Python e Razor.

Esta seção explica como criar, inserir e usar snippets no código.

Inserindo um snippet

Há algumas maneiras de adicionar snippets de código, algumas das quais são descritas abaixo:

  • Guia Expansão – Comece digitando o nome do modelo, selecione-o na lista e pressione Tab, Tab para adicioná-lo:

    Guia Expansão no código

  • Caixa de ferramentas – Use a Janela da Caixa de Ferramentas para exibir uma lista de todos os snippets de código. Arraste qualquer modelo da caixa de ferramentas para a posição correta no código-fonte:

    Snippets de código na Caixa de Ferramentas

  • Comando Inserir Modelos – Atualmente, não há nenhuma associação de teclas definida para a inserção de modelos. Para criar uma, navegue até Visual Studio > Preferências > Associações de teclas e pesquise template. Isso permite adicionar a associação de teclas desejada no campo Editar associação e clicar em Aplicar:

    Comando Inserir Modelo

Criando um novo modelo

Embora haja muitos modelos existentes em uma variedade de linguagens que você pode usar e editar, novos modelos também podem ser adicionados navegando para Visual Studio > Preferências > Editor de texto > Snippets de código:

Inserir novo modelo

Pressione os botões Adicionar ou Editar para criar ou editar snippets.

Palavras-chave em snippets de código

Depois da inserção de um snippet de código no editor, as palavras-chave definidas são realçadas e podem ser editadas usando tabulações entre elas. Palavras-chave se comportam como uma "variável" no snippet de código. Para defini-las, coloca-se um sinal de cifrão $ antes e após o nome da palavra-chave.

A janela Editar modelo é exibida abaixo, editando o snippet prop interno. O snippet contém duas palavras-chave e que podem ter propriedades mais definidas (como um valor padrão e dica de ferramenta) no lado – $type$ direito da $name$ – janela:

Janela Editar modelo

Os campos a seguir servem para definir um snippet:

  • Atalho – O texto que o usuário digita para inserir o snippet.
  • Agrupar – Os snippets são agrupados no menu de conteúdo do snippet usando este valor.
  • Descrição – Explicação sobre a finalidade do snippet.
  • MIME – Controla em quais tipos de arquivo o snippet está disponível.
  • Modelo Expansível – Marque esta opção para que o snippet possa ser inserido no cursor, ao digitar o atalho.
  • Modelo surround with – Marque esta opção para exibir este atalho no menu de conteúdo Surround with... do editor.
  • Modelo de texto – O snippet real que será inserido no editor. É possível definir espaços reservados para palavras-chave adicionando sinais de cifrão ao redor de um token; por exemplo, $type$.
  • Painel de propriedades de palavra-chave – No lado direito da janela, use a lista suspensa na parte superior para escolher uma palavra-chave, por exemplo, type, e edite propriedades, como um valor padrão ou uma dica de ferramenta.

Como usar palavras-chave no editor

Para usar um snippet com palavras-chave, como a definida acima, digite o atalho e pressione a tecla Tab duas vezes para que o conteúdo do snippet seja inserido no cursor:

Snippet inserido mostrando palavras-chave

Pressione a tecla Tab para navegar entre object e MyProperty a fim de personalizar o snippet para a classe.

É possível repetir uma palavra-chave no snippet, como o exemplo for. Observe que a palavra-chave $i$ é exibida três vezes:

Modelo de snippet com palavras-chave repetidas

Quando usado no editor, a tecla Tab alternará entre a primeira instância de i e max. Se você sobrescrever i com um nome variável diferente, as três instâncias serão atualizadas:

Snippet inserido mostrando várias palavras-chave

Palavras-chave reservadas

Há duas palavras-chave reservadas que você pode usar em um snippet de código:

  • $selected$ – Se o snippet tiver a opção Modelo surround with marcada, esta palavra-chave será substituída pelo texto que foi realçado no editor quando o snippet foi escolhido.
  • $end$Quando o usuário terminar de editar as palavras-chave em um – snippet, o cursor será colocado no local da palavra-chave $end$ .

O snippet for da seção anterior é um exemplo de palavras-chave reservadas.

Confira também