Compartilhar via


Passo a passo: Criando um trecho de código

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 apropriadas, e para adicionar seu código.Você também pode adicionar referências e parâmetros de substituição para o seu código.Você pode adicionar o trecho a sua instalação do Visual Studio usando o botão de importação no gerenciador de trechos de códigoFerramentas/gerenciador de trechos de código().

DicaDica

Para obter informações sobre como escrever mais facilmente trechos de código, procure o site de CodePlex por ferramentas da comunidade como Editor de trecho.

Modelo de trecho

O exemplo 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

  1. Crie um novo arquivo XML no Visual Studio e adicione o modelo mostrado acima.

  2. Preencha o título de trechos, por exemplo.. “hello world” VB, no elemento de título.

  3. Preencha o idioma trecho de código no atributo de linguagens do elemento de código.Para esse exemplo, use “VB”.

  4. 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>
    
  5. Salve o trecho como VBCodeSnippet.snippet.

Para adicionar um trecho de código em Visual Studio

  1. Você pode adicionar seus próprios trechos a sua instalação do Visual Studio usando o gerenciador de trechos de código.Abra o gerenciador de trechos de códigoFerramentas/gerenciador de trechos de código().

  2. Clique no botão de Importar .

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

  4. A caixa de diálogo de Importar Trecho de Código abre, 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 Concluir, em seguida OK.

  5. O trecho é copiado para o seguinte local:

    %USERPROFILE%\Documents\Visual Studio 2012\Code Snippets\Visual Basic\My Code Snippets

  6. Testar o trecho abrir um projeto do Visual Basic e abrir um arquivo de código.Clique em Inserir Trecho do arquivo no menu de contexto, em seguida meus trechos de código.Você deve ver um trecho meu trecho de código Visual Basicchamado.Clique duas vezes em.

  7. Você deve ver Console.WriteLine("Hello, World!") inserido no código.

Adicionando campos de descrição e de atalho

  1. 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 %USERPROFILE%\Documents\Visual Studio 2012\Code Snippets\Visual Basic\My Code Snippet\VBCodeSnippet.snippetdo arquivo.

  2. Adicione elementos de autor e descrição para o elemento do cabeçalho, e preencha-os.

  3. O elemento de cabeçalho deve ser nada mais semelhante:

    <Header>
        <Title>Hello World VB</Title>
        <Author>Myself</Author>
        <Description>Says Hello to the world.</Description>
    </Header>
    
  4. Abra o gerenciador de trechos de código e selecione o trecho de código.Em o painel direito você deve ver que a descrição e os campos de autor são preenchidos agora.

  5. Para adicionar um atalho, adicione um elemento de atalho ao lado do elemento do 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>
    
  6. Salve o arquivo de trecho novamente.

  7. Para testar o atalho, abra um projeto Visual Basic e abrir um arquivo de código.Digite em hello world TAB do arquivo e o pressionamento.O trecho de código deve ser inserido.

Para adicionar referências e imports

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

  2. Abra o trecho.

  3. Adicione o elemento das referências no elemento de trecho:

    <References>
        <Reference>
            <Assembly>System.Windows.Forms.dll</Assembly>
        </Reference>
    </References>
    
  4. Adicione o elemento imports no elemento de trecho:

    <Imports>
        <Import>
           <Namespace>System.Windows.Forms</Namespace>
        </Import>
    </Imports>
    
  5. Altere a seção CDATA ao seguinte:

    <![CDATA[MessageBox.Show("Hello, World!")]]>
    
  6. Salve o trecho.

  7. Abra um projeto Visual Basic e adicione o trecho.

  8. Você verá uma declaração imports na parte superior do arquivo de código a seguir:

    Imports System.Windows.Forms
    
  9. Examine as propriedades do projeto.O guia de referências inclui uma referência a System.Windows.Forms.dll.

Adicionando alternativas

  1. Você pode querer que partes dos trechos de código a ser substituídos pelo usuário, por exemplo se você adicionar uma variável e deseja que o usuário para substituir a variável com um no projeto atual.Você pode fornecer dois tipos de substituições: literais e objetos.Literais são cadeias de caracteres de qualquer 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 diferente de uma cadeia de caracteres.Em esse procedimento você declarará uma substituição literal e uma substituição do objeto, e modifica o código para referenciar essas alternativas.

  2. Abra o trecho.

  3. Este exemplo usa uma cadeia de conexão SQL, portanto você precisa alterar as importações e referencia os elementos para adicionar referências apropriados:

    <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>
    
  4. Para declarar uma substituição literal para a cadeia de conexão SQL, adicione um elemento das declarações no elemento de trecho de código, e ela adicione um elemento literal com subelements para a identificação, a dica de ferramenta, e o valor padrão para substituição:

    <Declarations>
        <Literal>
            <ID>SqlConnString</ID>
            <ToolTip>Replace with a SQL connection string.</ToolTip>
            <Default>"SQL connection string"</Default>
        </Literal>
    </Declarations>
    
  5. Para declarar uma substituição do objeto para a conexão SQL, adicione um elemento no elemento das declarações, e adicione subelementos para a identificação, o tipo de objeto, a dica de ferramenta, e o valor padrão.O elemento resultante de declarações deve ser assim:

    <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>
    
  6. Em a seção de código, você faz referência às substituições com o redor de sinais de $, por exemplo $replacement$:

    <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>
    
  7. Salve o trecho.

  8. Abra um projeto Visual Basic e adicione o trecho.

  9. O código deve parecer como a seguir, onde as substituições Cadeia de conexão SQL e dcConnection são realçadas em claro laranja.Pressione a tecla TAB de 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 de trechos de código