Trechos de código e como usá-los

2025-06-12

Trechos de código são pequenos blocos de código reutilizável que você pode adicionar a um arquivo de código. Os trechos geralmente contêm blocos de código usados com frequência, como blocos Try...Finally ou If...Else. Você também pode usar trechos de código para adicionar classes ou métodos inteiros.

Um trecho de código tem um título que você usa para selecionar o trecho e pode ter um nome de atalho que você pode digitar para inserir o trecho. Os trechos também podem conter parâmetros substituíveis, que atuam como espaços reservados. Trechos estão disponíveis para muitas linguagens, incluindo C#, C++ e Visual Basic.

Trechos de expansão e trechos envolventes

Você pode adicionar dois tipos de trechos de código ao seu código:

Um trecho de expansão é adicionado em um ponto de inserção especificado.
Um snippet surround-with é adicionado em torno do código selecionado e está disponível apenas para C# e C++.

Encontre trechos disponíveis

Para ver os snippets disponíveis para um idioma, selecione Ferramentas>Gerenciador de Snippets de Código na barra de menus ou pressione Ctrl+K, B e depois selecione o idioma desejado no menu suspenso.

Captura de ecrã da caixa de diálogo Gestor de Trechos de Código.

Para criar e importar seu próprio trecho para que ele apareça na lista de trechos, consulte Passo a passo: Criar um trecho de código no Visual Studio.

Adicionar um trecho a um arquivo de código

Para adicionar um trecho a um arquivo de código:

No editor de códigos, coloque o cursor ou selecione o código C# ou C++ onde deseja adicionar o trecho.
Efetue uma das seguintes ações:
- Na barra de menus do Visual Studio, escolha Edit>IntelliSense>Insert Snippet ou Edit>IntelliSense>Surround With.
- Clique com o botão direito do mouse e escolha Snippet>Insert Snippet ou Snippet>Surround With no menu de contexto.
- No teclado, pressione Ctrl+K, X para um fragmento de expansão ou Ctrl+K, S para um fragmento de envolvimento.
Clique duas vezes no trecho desejado na lista suspensa ou digite o atalho do trecho e pressione Tab ou Enter.

Adicionar um fragmento de expansão

Por exemplo, o trecho tryf de expansão C# adiciona o seguinte Try...Finally bloco:

try
{

}
finally
{

}

Para adicionar este trecho de expansão:

No editor de códigos, posicione o cursor onde deseja adicionar o trecho.
Clique com o botão direito do mouse e selecione Inserir trecho no menu de contexto do botão direito do mouse ou use a barra de menus ou os comandos do teclado.
Abra a pasta Visual C# e, em seguida, clique duas vezes em tryf na lista suspensa ou selecione tryf e pressione Tab ou Enter.

Sugestão

Também pode colocar o cursor no ponto de inserção, escrever tryf e, em seguida, premir Tab duas vezes.

Adicionar um trecho envolvente

No exemplo a seguir de um trecho em C++, o atalho if pode ser usado como um trecho de inserção ou como um trecho de envolvimento. Se selecionar a linha return FALSE; de código e, em seguida, escolher Envolver com>se, o trecho será expandido à volta da linha.

if (true)
{
    return FALSE;
}

Parâmetros de substituição de trechos

Os trechos podem conter parâmetros de substituição, que são espaços reservados que você deve substituir para se ajustar ao código que você está escrevendo. No exemplo anterior, true é um parâmetro de substituição, que você substitui pela condição apropriada. A substituição se repete para cada instância desse parâmetro de substituição no trecho.

Por exemplo, Visual Basic tem um trecho de código que define uma propriedade. Para inserir o trecho:

No menu de contexto do botão direito do mouse em um arquivo de código do Visual Basic, selecione Snippet>Insert Snippet.
Selecione Padrões de Código>Propriedades, Procedimentos, Eventos>Definir uma Propriedade.

Captura de tela do menu de trecho de código para Definir uma propriedade.

É inserido o seguinte código:

Private newPropertyValue As String
Public Property NewProperty() As String
    Get
        Return newPropertyValue
    End Get
    Set(ByVal value As String)
        newPropertyValue = value
    End Set
End Property

Se mudar newPropertyValue para m_property, todas as instâncias de newPropertyValue alteram-se. Se você alterar String para Int na declaração de propriedade, o Set valor no método também será alterado para Int.

Práticas recomendadas para usar trechos de código

O código em um trecho de código mostra apenas a maneira mais básica de fazer algo. Para a maioria dos aplicativos, o código deve ser modificado para se adequar ao aplicativo.

Processamento de exceções

Normalmente, os blocos de trechos de Try...Catch código capturam e relançam todas as exceções, mas essa pode não ser a escolha certa para seu projeto. Para cada exceção, há várias maneiras de responder. Para obter exemplos, consulte Como lidar com uma exceção usando try/catch (C#) e Try...Catch...Finally instrução (Visual Basic).

Locais dos arquivos

Ao adaptar os locais dos arquivos ao seu aplicativo, considere os seguintes fatores.

Encontre um local acessível. Os usuários podem não ter acesso à pasta Arquivos de Programas do computador, portanto, armazenar arquivos do usuário com os arquivos do aplicativo pode não funcionar.
Encontre um local seguro. Armazenar arquivos na pasta raiz como C:\ não é seguro. Para dados de aplicativos, é melhor usar a pasta Application Data . Para dados de usuários individuais, o aplicativo pode criar um arquivo na pasta Documentos de cada usuário.
Use um nome de arquivo válido. Você pode usar os OpenFileDialog controles e SaveFileDialog para reduzir a probabilidade de nomes de arquivo inválidos.
Lembre-se de que um arquivo selecionado pelo usuário pode ser excluído antes que seu código possa manipular o arquivo. Além disso, um usuário pode não ter permissão para gravar no arquivo.

Segurança

A segurança de um snippet depende de onde você o usa no código-fonte e como você o modifica uma vez que está no código. A lista a seguir contém algumas áreas a serem consideradas:

Acesso a ficheiros e bases de dados
Segurança de acesso ao código
Protegendo recursos como logs de eventos e registro
Guardar segredos
Verificação de entradas
Passando dados para tecnologias de script

Para obter mais informações, consulte Aplicativos seguros.

Trechos de código baixados

Trechos de código instalados pelo Visual Studio não são riscos de segurança em si. No entanto, eles podem criar riscos de segurança em seu aplicativo. Trechos baixados da internet devem ser tratados com extrema cautela, como qualquer outro conteúdo baixado. Transfira excertos apenas de sites em que confia e utilize software antivírus up-to-date.

Abra todos os arquivos de snippet baixados no Bloco de Notas ou no editor XML do Visual Studio e revise-os cuidadosamente antes de instalá-los. Cuidado com os seguintes problemas:

Código de trecho que pode danificar seu sistema se você executá-lo. Leia o código-fonte cuidadosamente antes de executá-lo.
HelpURL bloqueia ficheiros de fragmentos contendo URLs que executam arquivos de script maliciosos ou exibem sites ofensivos.
Trechos contendo referências que são adicionadas silenciosamente ao seu projeto e podem ser carregadas de qualquer lugar no seu sistema. Você pode baixar essas referências do mesmo local de onde você baixa um trecho. O trecho pode então chamar um método na referência que executa código mal-intencionado. Para detetar essas referências, reveja os blocos Imports e References do ficheiro de trechos.

Partilhar via