Instruções passo a passo: criando um trecho de código

Artigo
06/10/2015

Você pode criar um trecho de código com apenas algumas etapas.Tudo o que você precisa fazer é criar um arquivo XML, preencher os elementos apropriados e adicionar o código a ele.Você também pode adicionar referências e parâmetros de substituição ao seu código.Você pode adicionar o trecho à sua instalação do Visual Studio usando o botão Importar no Gerenciador de Trechos de Código (Ferramentas/Gerenciador de Trechos de Código).

Dica
Para obter informações sobre como escrever trechos de código com mais facilidade, procure ferramentas comunitárias, como o Editor de trechos, no site do CodePlex.

Modelo de trecho

Veja a seguir o modelo básico de trecho:

<?xml version="1.0" encoding="utf-8"?>
<CodeSnippets
    xmlns="https://schemas.microsoft.com/VisualStudio/2005/CodeSnippet">
    <CodeSnippet Format="1.0.0">
        <Header>
            <Title></Title>
        </Header>
        <Snippet>
            <Code Language="">
                <![CDATA[]]>
            </Code>
        </Snippet>
    </CodeSnippet>
</CodeSnippets>

Para criar um trecho de código

Crie um novo arquivo XML no Visual Studio e adicione o modelo mostrado acima.
Preencha o título do trechos, por exemplo, “Hello World VB", no elemento Título.
Preencha o idioma do trecho no atributo Idiomas do elemento Código.Para esse exemplo, use “VB”.
Adicionar qualquer código na seção CDATA dentro do elemento de código, por exemplo:
```
<Code Language="VB">
    <![CDATA[Console.WriteLine("Hello, World!")]]>
</Code>
```
Salve o trecho como VBCodeSnippet.snippet.

Para adicionar um trecho de código ao Visual Studio

Você pode adicionar seus próprios trechos à sua instalação do Visual Studio usando o Gerenciador de Trechos de Código.Abra o Gerenciador de Trechos de Código (Ferramentas/Gerenciador de Trechos de Código).
Clique no botão Importar.
Vá para o local onde você salvou o trecho de código no procedimento anterior, selecione-o e clique em Abrir.
A caixa de diálogo Importar Trecho de Código é aberta, solicitando que você escolha onde adicionar o trecho das opções no painel direito.Uma das opções deve ser Meus Trechos de Código.Selecione e clique em Finalizar, e então em OK.
O trecho é copiado para o seguinte local:

%USERPROFILE%\Documents\Visual Studio 2013\Code Snippets\Visual Basic\My Code Snippets
Testar o trecho abrindo um projeto do Visual Basic e abrir um arquivo de código.No arquivo, clique em Inserir Trecho no menu de contexto, então em Meus Trechos de Código.Você deve ver um trecho chamado Meu trecho de código Visual Basic.Clique duas vezes.
Você deve ver Console.WriteLine("Hello, World!") inserido no código.

Adicionando campos de descrição e de atalho

Os campos de descrição fornecem mais informações sobre o trecho de código quando exibidos no Gerenciador de Trechos de Código.O atalho é uma marca que os usuários poderão digitar para inserir o trecho.Edite o trecho que você adicionou abrindo o arquivo %USERPROFILE%\Documents\Visual Studio 2013\Code Snippets\Visual Basic\My Code Snippet\VBCodeSnippet.snippet.
Adicione elementos de autor e descrição para o elemento de cabeçalho, e preencha-os.

O elemento do cabeçalho deve se parecer com este:

<Header>
    <Title>Hello World VB</Title>
    <Author>Myself</Author>
    <Description>Says Hello to the world.</Description>
</Header>

Abra o Gerenciador de Trechos de Código e selecione seu trecho de código.No painel direito, você deverá ver que agora os campos Descrição e Autor estão preenchidos.

Para adicionar um atalho, adicione um elemento de atalho ao lado do elemento de autor e de descrição:

<Header>
    <Title>Hello World VB</Title>
    <Author>Myself</Author>
    <Description>Says Hello to the world.</Description>
    <Shortcut>hello</Shortcut>
</Header>

Salve o arquivo de trecho novamente.
Para testar o atalho, abra um projeto do Visual Basic e abra um arquivo de código.Digite hello no arquivo e o pressione TAB.O trecho de código deve ser inserido.

Para adicionar referências e importações

Com trechos do Visual Basic você pode adicionar uma referência a um projeto usando o elemento de referências, e adicionar uma declaração de importações usando o elemento Imports. (Os trechos em outros idiomas não têm esse recurso.) Por exemplo, se você alterar Console.WriteLine no exemplo de código para MessageBox.Show, há a possibilidade de que você precise adicionar o assembly de System.Windows.Forms.dll ao projeto.
Abra o trecho.

Adicione o elemento Referências no elemento de trecho:

<References>
    <Reference>
        <Assembly>System.Windows.Forms.dll</Assembly>
    </Reference>
</References>

Adicione o elemento Imports no elemento de trecho:

<Imports>
    <Import>
       <Namespace>System.Windows.Forms</Namespace>
    </Import>
</Imports>

Altere a seção CDATA para o seguinte:

<![CDATA[MessageBox.Show("Hello, World!")]]>

Salve o trecho.
Abra um projeto do Visual Basic e adicione o trecho.
Você verá uma instrução Imports na parte superior do arquivo de código:
```
Imports System.Windows.Forms
```
Examine as propriedades do projeto.O guia de referências inclui uma referência a System.Windows.Forms.dll.

Adicionando alternativas

Pode ser que você queira que partes dos trechos de código a ser substituídas pelo usuário, por exemplo se você adicionar uma variável e quiser que o usuário substitua por um uma do projeto atual.Você pode fornecer dois tipos de substituições: literais e objetos.Literais são cadeias de caracteres de algum tipo (literais de cadeia de caracteres, nomes de variável ou representações de cadeia de caracteres de valores numéricos).Os objetos são instâncias de qualquer tipo diferentes de uma cadeia de caracteres.Neste procedimento, você declarará uma substituição literal e uma substituição de objeto, e altera o código para referenciar essas substituições.
Abra o trecho.

Este exemplo usa uma cadeia de conexão SQL, portanto é necessário alterar os elementos de importação e referencia para adicionar as referências apropriadas:

<References>
    <Reference>
        <Assembly>System.Data.dll</Assembly>
    </Reference>
    <Reference>
        <Assembly>System.Xml.dll</Assembly>
    </Reference>
</References>
<Imports>
    <Import>
        <Namespace>System.Data</Namespace>
    </Import>
    <Import>
        <Namespace>System.Data.SqlClient</Namespace>
    </Import>
</Imports>

Para declarar uma substituição de literal para a cadeia de conexão SQL, adicione um elemento de declarações no elemento de trecho de código, e nele, adicione um elemento literal com subelements para a ID, dica de ferramenta, e o valor padrão da substituição:
```
<Declarations>
    <Literal>
        <ID>SqlConnString</ID>
        <ToolTip>Replace with a SQL connection string.</ToolTip>
        <Default>"SQL connection string"</Default>
    </Literal>
</Declarations>
```

Para declarar uma substituição de objeto para a conexão SQL, adicione um elemento de objeto no elemento de declarações, e adicione subelementos para a ID, tipo de objeto, dica de ferramenta, e o valor padrão.O elemento resultante de declarações deve se parecer com este:

<Declarations>
    <Literal>
        <ID>SqlConnString</ID>
        <ToolTip>Replace with a SQL connection string.</ToolTip>
        <Default>"SQL connection string"</Default>
    </Literal>
    <Object>
        <ID>SqlConnection</ID>
        <Type>System.Data.SqlClient.SqlConnection</Type>
        <ToolTip>Replace with a connection object in your application.</ToolTip>
        <Default>dcConnection</Default>
    </Object>
</Declarations>

Na seção de código, você faz referência às substituições entre símbolos de $, por exemplo, $substituição$:

<Code Language="VB" Kind="method body">
    <![CDATA[Dim daCustomers As SqlDataAdapter
        Dim selectCommand As SqlCommand

        daCustomers = New SqlClient.SqlDataAdapter()
        selectCommand = new SqlClient.SqlCommand($SqlConnString$)
        daCustomers.SelectCommand = selectCommand
        daCustomers.SelectCommand.Connection = $SqlConnection$]]>
</Code>

Salve o trecho.
Abra um projeto do Visual Basic e adicione o trecho.

O código deve parecer como o seguinte, onde as substituições da Cadeia de conexão SQL e dcConnection são realçadas em laranja claro.Pressione a tecla TAB para navegar de um para o outro.

Dim daCustomers As SqlDataAdapter
Dim selectCommand As SqlCommand

daCustomers = New SqlClient.SqlDataAdapter()
selectCommand = New SqlClient.SqlCommand("SQL connection string")
daCustomers.SelectCommand = selectCommand
daCustomers.SelectCommand.Connection = dcConnection

Consulte também

Conceitos

Referência de esquema dos trechos de código

Compartilhar via