Partilhar via

Referência de esquema dos trechos de código

  • Artigo

Os Trechos de Código IntelliSense são partes de código pré-criadas que estão prontas para serem inseridas no seu aplicativo com o Visual Studio. Você pode aumentar a produtividade fornecendo trechos de código que reduzem a quantidade de tempo gasto digitando código repetitivo ou procurando exemplos. É possível usar o esquema XML do Trecho de Código IntelliSense para criar seus próprios trechos de código e adicioná-los aos trechos de código que o Visual Studio já contém.

Elementos do esquema de Trechos de Código IntelliSense

Assembly Element

HelpUrl Element

References Element

Author Element

ID Element

Shortcut Element

Code Element

Import Element

Snippet Element

CodeSnippet Element

Imports Element

SnippetType Element

CodeSnippets Element

Keyword Element

SnippetTypes Element

Declarations Element

Keywords Element

Title Element

Default Element

Literal Element

ToolTip Element

Description Element

Namespace Element

Type Element

Function Element

Object Element

Url Element

Header Element

Reference Element

Elemento Assembly

Especifica o nome do assembly referenciado pelo trecho de código.

Dica

O elemento Assembly tem suporte apenas de trechos de código Visual Basic.

O valor de texto do elemento Assembly é o nome de texto amigável do assembly, como System.dll, ou seu nome forte, como System,Version=1.0.0.1,Culture=neutral,PublicKeyToken=9b35aa323c18d4fb1.

<Assembly>
    AssemblyName
</Assembly>

Elementos pai

Descrição

Reference Element

Contém informações sobre referências de assembly exigidas pelo trecho de código.

Um valor de texto é obrigatório. Esse texto especifica o assembly ao qual o trecho de código faz referência.

Elemento Author

Especifica o nome do autor do trecho de código. O Gerenciador de Trechos de Código exibe o nome armazenado no elemento Author do trecho de código.

<Author>
   Code Snippet Author
</Author>

Elementos pai

Descrição

Header Element

Contém informações gerais sobre o trecho de código.

Um valor de texto é obrigatório. Esse texto especifica o autor do trecho de código.

Elemento Code

Fornece um contêiner para blocos de códigos curtos.

Duas palavras reservadas estão disponíveis para uso no texto do elemento Code: $end$ e $selected$. $end$ marca o local para colocar o cursor depois que o trecho de código é inserido. $selected$ representa o texto selecionado no documento que deve ser inserido no trecho quando ele é invocado. Por exemplo, dado um trecho que inclui:

$selected$ is a great color.

Se a palavra "Blue" for selecionada, quando o usuário invoca o modelo, o resultado é:

Blue is a great color.

Você não pode usar o $end$ ou $selected$ mais de uma vez em um trecho de código. Nesse caso, apenas a segunda instância é reconhecida. Dado um trecho que inclui:

$selected$ is a great color. I love $selected$.

Se a palavra "Blue" for selecionada, o resultado é:

 is a great color. I love Blue.

O espaço inicial aparece porque há um espaço entre $selected$ e is.

Todas as outras palavras-chave $ são dinamicamente definidas nas marcas <Literal> e <Object>.

<Code Language="Language"
    Kind="method body/method decl/type decl/page/file/any"
    Delimiter="Delimiter">
    Code to insert
</Code>

Atributo

Descrição

Delimiter

Atributo opcional. Especifica o delimitador usado para descrever os literais e os objetos no código. Por padrão, o delimitador é $.

Kind

Atributo opcional. Especifica o tipo de código que o trecho contém e o local em que um trecho de código deve ser inserido para compilação. Os valores disponíveis são method body, method decl, type decl, file e any.

Language

Atributo obrigatório. Especifica a linguagem do trecho de código.

Valor do atributo do tipo

Descrição

method body

Especifica que o trecho de código é um corpo de método e, portanto, deve ser inserido em uma declaração de método.

method decl

Especifica que o trecho de código é um método e, portanto, deve ser inserido em uma classe ou um módulo.

type decl

Especifica que o trecho de código é um tipo e, portanto, deve ser inserido em uma classe, um módulo ou um namespace.

file

Especifica que o trecho é um arquivo de código completo. Esses trechos de código podem ser inseridos sozinhos em um arquivo de código ou dentro de um namespace.

any

Especifica que o trecho pode ser inserido em qualquer lugar. Essa marca é usada para trechos de código que não dependem de contexto, como os comentários.

Valor do atributo da linguagem

Descrição

VB

Identifica um trecho de código Visual Basic.

CSharp

Identifica um trecho de código C#.

CPP

Identifica um trecho de código C++.

XML

Identifica um trecho de código XML.

JavaScript

Identifica um trecho de código JavaScript.

SQL

Identifica um trecho de código SQL.

HTML

Identifica um trecho de código HTML.

Elementos pai

Descrição

Snippet Element

Contém as referências, as importações, as declarações e o código do trecho de código.

Um valor de texto é obrigatório. Esse texto especifica o código, juntamente como os literais e objetos, que você pode usar quando esse trecho de código é inserido em um projeto.

Elemento CodeSnippet

Permite que você especifique um título e vários Trechos de Código IntelliSense, que podem ser inseridos em arquivos de código do Visual Studio.

<CodeSnippet Format="x.x.x">
    <Header>... </Header>
    <Snippet>... </Snippet>
</CodeSnippet>

Atributo

Descrição

Format

Atributo obrigatório. Especifica a versão do esquema do trecho de código. O atributo Format deve ser uma cadeia de caracteres na sintaxe x.x.x, em que cada "x" representa um valor numérico do número da versão. O Visual Studio vai ignorar trechos de código com atributos Format que ele não entende.

Elementos filho

Descrição

Header Element

Elemento obrigatório. Contém informações gerais sobre o trecho de código. Deve haver exatamente um elemento Header em um trecho de código.

Snippet Element

Elemento obrigatório. Contém o código que será inserido pelo Visual Studio. Deve haver exatamente um elemento Snippet em um trecho de código.

Elementos pai

Descrição

CodeSnippets Element

Elemento raiz do esquema XML do trecho de código.

Elemento CodeSnippets

Agrupa elementos CodeSnippet Element. O elemento CodeSnippets é o elemento raiz do esquema XML do trecho de código.

<CodeSnippets>
    <CodeSnippet>... </CodeSnippet>
</CodeSnippets>

Elementos filho

Descrição

CodeSnippet Element

Elemento opcional. Elemento pai de todos os dados do trecho de código. Pode ser que não haja nenhum ou mais de um elemento CodeSnippet em um elemento CodeSnippets.

Elemento Declarations

Especifica os literais e os objetos que compõem as partes de um trecho de código que você pode editar.

<Declarations>
    <Literal>... </Literal>
    <Object>... </Object>
</Declarations>

Elementos filho

Descrição

Literal Element

Elemento opcional. Define os literais do trecho de código que você pode editar. Pode ser que não haja nenhum ou mais de um elemento Literal em um elemento Declarations.

Object Element

Elemento opcional. Define os objetos do trecho de código que você pode editar. Pode ser que não haja nenhum ou mais de um elemento Object em um elemento Declarations.

Elementos pai

Descrição

Snippet Element

Contém as referências, as importações, as declarações e o código do trecho de código.

Elemento Default

Especifica o valor padrão do literal ou do objeto para um Trecho de Código IntelliSense.

<Default>
    Default value
</Default>

Elementos pai

Descrição

Literal Element

Define os campos de literal do trecho de código que você pode editar.

Object Element

Define os campos de objeto do trecho de código que você pode editar.

Um valor de texto é obrigatório. Esse texto especifica o valor padrão do literal ou do objeto que preenche os campos do trecho de código que você pode editar.

Elemento Description

Especifica as informações descritivas sobre o conteúdo de um Trecho de Código IntelliSense.

<Description>
    Code Snippet Description
</Description>

Elementos pai

Descrição

Header Element

Contém informações gerais sobre o trecho de código.

Um valor de texto é obrigatório. Esse texto descreve o trecho de código.

Elemento Function

Especifica uma função a ser executada quando o literal ou o objeto receber foco no Visual Studio.

Dica

O elemento Function tem suporte apenas em trechos de código Visual C#.

<Function>
    FunctionName
</Function>

Elementos pai

Descrição

Literal Element

Define os campos de literal do trecho de código que você pode editar.

Object Element

Define os campos de objeto do trecho de código que você pode editar.

Um valor de texto é obrigatório. Esse texto especifica uma função a ser executada quando o campo de literal ou objeto recebe foco no Visual Studio.

Elemento Header

Especifica informações gerais sobre o Trecho de Código IntelliSense.

<Header>
    <Title>... </Title>
    <Author>... </Author>
    <Description>... </Description>
    <HelpUrl>... </HelpUrl>
    <SnippetTypes>... </SnippetTypes>
    <Keywords>... </Keywords>
    <Shortcut>... </Shortcut>
</Header>

Elementos filho

Descrição

Author Element

Elemento opcional. O nome da pessoa ou da empresa que criou o trecho de código. Pode ser que não haja nenhum ou um elemento Author em um elemento Header.

Description Element

Elemento opcional. Uma descrição do trecho de código. Pode ser que não haja nenhum ou um elemento Description em um elemento Header.

HelpUrl Element

Elemento opcional. Uma URL que contém mais informações sobre o trecho de código. Pode ser que não haja nenhum ou um elemento HelpURL em um elemento Header.

Dica

O Visual Studio não usa o elemento HelpUrl.O elemento faz parte do esquema XML do Trecho de Código IntelliSense e qualquer trecho de código que contenha o elemento será válido, mas o valor do elemento nunca será usado.

Keywords Element

Elemento opcional. Agrupa elementos Keyword. Pode ser que não haja nenhum ou um elemento Keywords em um elemento Header.

Shortcut Element

Elemento opcional. Especifica o texto de atalho que pode ser usado para inserir o trecho. Pode ser que não haja nenhum ou um elemento Shortcut em um elemento Header.

SnippetTypes Element

Elemento opcional. Agrupa elementos SnippetType. Pode ser que não haja nenhum ou um elemento SnippetTypes em um elemento Header. Se não houver nenhum elemento SnippetTypes, o trecho de código sempre será válido.

Title Element

Elemento obrigatório. O nome amigável do trecho de código. Deve haver exatamente um elemento Title em um elemento Header.

Elementos pai

Descrição

CodeSnippet Element

Elemento pai de todos os dados do trecho de código.

Elemento HelpUrl

Especifica uma URL que fornece mais informações sobre um trecho de código.

Dica

O Visual Studio não usa o elemento HelpUrl.O elemento faz parte do esquema XML do Trecho de Código IntelliSense e qualquer trecho de código que contenha o elemento será válido, mas o valor do elemento nunca será usado.

<HelpUrl>
    www.microsoft.com
</HelpUrl>

Elementos pai

Descrição

Header Element

Contém informações gerais sobre o trecho de código.

Um valor de texto é opcional. Esse texto especifica a URL a ser visitada para obter mais informações sobre um trecho de código.

Elemento ID

Especifica um identificador exclusivo para um elemento Literal ou Object. Dois literais ou objetos no mesmo trecho de código não podem ter o mesmo valor de texto em seus elementos ID. Literais e objetos não podem conter um elemento ID com um valor de fim. O valor $end$ é reservado e usado para marcar o local onde colocar o cursor depois que o trecho de código é inserido.

<ID>
    Unique Identifier
</ID>

Elementos pai

Descrição

Literal Element

Define os campos de literal do trecho de código que você pode editar.

Object Element

Define os campos de objeto do trecho de código que você pode editar.

Um valor de texto é obrigatório. Esse texto especifica o identificador exclusivo do objeto ou literal.

Elemento Import

Especifica os namespaces importados usados por um Trecho de Código IntelliSense.

Dica

O elemento Import tem suporte apenas em projetos do Visual Basic.

<Import>
    <Namespace>... </Namespace>
</Import>

Elementos filho

Descrição

Namespace Element

Elemento obrigatório. Especifica o namespace usado pelo trecho de código. Deve haver exatamente um elemento Namespace em um elemento Import.

Elementos pai

Descrição

Imports Element

Elemento de agrupamento de elementos Import.

Elemento Imports

Agrupa elementos Import individuais.

Dica

O elemento Imports tem suporte apenas em projetos do Visual Basic.

<Imports>
    <Import>... </Import>
<Imports>

Elementos filho

Descrição

Import Element

Elemento opcional. Contém os namespaces importados para o trecho de código. Pode ser que não haja nenhum ou mais de um elemento Import em um elemento Imports.

Elementos pai

Descrição

Snippet Element

Contém as referências, as importações, as declarações e o código do trecho de código.

Elemento Keyword

Especifica uma palavra-chave personalizada para o trecho de código. As palavras-chave de trecho de código são usadas pelo Visual Studio e representam uma maneira padronizada de os provedores de conteúdo online adicionarem palavras-chave personalizadas para pesquisa ou categorização.

<Keyword>
    Code Snippet Keyword
</Keyword>

Elementos pai

Descrição

Keywords Element

Agrupa elementos Keyword individuais.

Um valor de texto é obrigatório. A palavra-chave para o trecho de código.

Elemento Keywords

Agrupa elementos Keyword individuais. As palavras-chave de trecho de código são usadas pelo Visual Studio e representam uma maneira padronizada de os provedores de conteúdo online adicionarem palavras-chave personalizadas para pesquisa ou categorização

<Keywords>
    <Keyword>... </Keyword>
    <Keyword>... </Keyword>
<Keywords>

Elementos filho

Descrição

Keyword Element

Elemento opcional. Contém palavras-chave individuais para o trecho de código. Pode ser que não haja nenhum ou mais de um elemento Keyword em um elemento Keywords.

Elementos pai

Descrição

Header Element

Contém informações gerais sobre o trecho de código.

Elemento Literal

Define os literais do trecho de código que você pode editar. O elemento Literal é usado para identificar um substituto para uma parte de código totalmente contido no trecho, mas que provavelmente será personalizado depois de inserido no código. Por exemplo, cadeias de caracteres literais, valores numéricos e alguns nomes de variáveis devem ser declarados como literais.

Os literais e objetos não podem conter um elemento ID com um valor de selecionado ou fim. O valor $selected$ representa o texto selecionado no documento que deve ser inserido no trecho quando ele é invocado. $end$ marca o local para colocar o cursor depois que o trecho de código é inserido.

<Literal Editable="true/false">
   <ID>... </ID>
   <ToolTip>... </ToolTip>
   <Default>... </Default>
   <Function>... </Function>
</Literal>

Atributo

Descrição

Editable

Atributo Boolean opcional. Especifica se você pode editar ou não o literal depois de inserido o trecho de código. O valor padrão desse atributo é true.

Elementos filho

Descrição

Default Element

Elemento obrigatório. Especifica o valor padrão do literal quando você insere o trecho de código. Deve haver exatamente um elemento Default em um elemento Literal.

Function Element

Elemento opcional. Especifica uma função a ser executada quando o literal recebe foco no Visual Studio. Pode ser que não haja nenhum ou um elemento Function em um elemento Literal.

ID Element

Elemento obrigatório. Especifica um identificador exclusivo para o literal. Deve haver exatamente um elemento ID em um elemento Literal.

ToolTip Element

Elemento opcional. Descreve o valor esperado e o uso do literal. Pode ser que não haja nenhum ou um elemento Tooltip em um elemento Literal.

Elementos pai

Descrição

Declarations Element

Contém os literais e objetos de um trecho de código que você pode editar.

Elemento Namespace

Especifica o namespace que deve ser importado para compilação e execução do trecho de código. O namespace especificado no elemento Namespace é adicionado automaticamente a uma instrução Imports no início do código, se ele ainda não existir.

Dica

O elemento Namespace tem suporte apenas em projetos do Visual Basic.

<Namespace>
    Namespace
</Namespace>

Elementos pai

Descrição

Import Element

Importa o namespace especificado.

Um valor de texto é obrigatório. Esse texto especifica um namespace que o trecho de código supõe que seja importado.

Elemento Object

Define os objetos do trecho de código que você pode editar. O elemento Object é usado para identificar um item que é exigido pelo trecho de código, mas que provavelmente será definido fora do trecho em si. Por exemplo, os controles do Windows Forms, os controles do ASP.NET, as instâncias do objeto e as instâncias do tipo devem ser declarados como objetos. As declarações de objeto exigem que um tipo seja especificado, o que é feito com o elemento Type.

<Object Editable="true/false">
    <ID>... </ID>
    <Type>... </Type>
    <ToolTip>... </ToolTip>
    <Default>... </Default>
    <Function>... </Function>
</Object>

Atributo

Descrição

Editable

Atributo Boolean opcional. Especifica se você pode editar ou não o literal depois de inserido o trecho de código. O valor padrão desse atributo é true.

Elementos filho

Descrição

Default Element

Elemento obrigatório. Especifica o valor padrão do literal quando você insere o trecho de código. Deve haver exatamente um elemento Default em um elemento Literal.

Function Element

Elemento opcional. Especifica uma função a ser executada quando o literal recebe foco no Visual Studio. Pode ser que não haja nenhum ou um elemento Function em um elemento Literal.

ID Element

Elemento obrigatório. Especifica um identificador exclusivo para o literal. Deve haver exatamente um elemento ID em um elemento Literal.

ToolTip Element

Elemento opcional. Descreve o valor esperado e o uso do literal. Pode ser que não haja nenhum ou um elemento Tooltip em um elemento Literal.

Type Element

Elemento obrigatório. Especifica o tipo do objeto. Deve haver exatamente um elemento Type em um elemento Object.

Elementos pai

Descrição

Declarations Element

Contém os literais e objetos de um trecho de código que você pode editar.

Elemento Reference

Especifica informações sobre as referências de assembly exigidas pelo trecho de código.

Dica

O elemento Reference tem suporte apenas em projetos do Visual Basic.

<Reference>
    <Assembly>... </Assembly>
    <Url>... </Url>
</Reference>

Elementos filho

Descrição

Assembly Element

Elemento obrigatório. Contém o nome do assembly referenciado pelo trecho de código. Deve haver exatamente um elemento Assembly em um elemento Reference.

Url Element

Elemento opcional. Contém uma URL que fornece mais informações sobre o assembly referenciado. Pode ser que não haja nenhum ou um elemento Url em um elemento Reference.

Elementos pai

Descrição

References Element

Elemento de agrupamento de elementos Reference.

Elemento References

Agrupa elementos Reference individuais.

Dica

O elemento References tem suporte apenas em projetos do Visual Basic.

<References>
    <Reference>... </Reference>
</References>

Elementos filho

Descrição

Reference Element

Elemento opcional. Contém informações sobre referências de assembly para o trecho de código. Pode ser que não haja nenhum ou mais de um elemento Reference em um elemento References.

Elementos pai

Descrição

Snippet Element

Contém as referências, as importações, as declarações e o código do trecho de código.

Elemento Shortcut

Especifica o texto do atalho usado para inserir o trecho. O valor de texto de um elemento Shortcut pode conter apenas caracteres alfanuméricos, hifens ( - ) e sublinhados ( _ ).

Aviso

_ e – não são caracteres com suporte nos atalhos de trecho do C++.

<Shortcut>
    Shortcut Text
</Shortcut>

Elementos pai

Descrição

Header Element

Contém informações gerais sobre o trecho de código.

Um valor de texto é opcional. Esse texto é usado como um atalho para inserção do trecho de código.

Elemento Snippet

Especifica as referências, as importações, as declarações e o código do trecho de código.

<Snippet>
    <References>... </References>
    <Imports>... </Imports>
    <Declarations>... </Declarations>
    <Code>... </Code>
</Snippet>

Elementos filho

Descrição

Code Element

Elemento obrigatório. Especifica o código que você deseja inserir em um arquivo de documentação. Deve haver exatamente um elemento Code em um elemento Snippet.

Declarations Element

Elemento opcional. Especifica os literais e os objetos que compõem as partes de um trecho de código que você pode editar. Pode ser que não haja nenhum ou um elemento Declarations em um elemento Snippet.

Imports Element

Elemento opcional. Agrupa elementos Import individuais. Pode ser que não haja nenhum ou um elemento Imports em um elemento Snippet.

Elemento opcional. Agrupa elementos Reference individuais. Pode ser que não haja nenhum ou um elemento References em um elemento Snippet.

Elementos pai

Descrição

CodeSnippet Element

Permite que você especifique um título e vários Trechos de Código IntelliSense, que podem ser inseridos em arquivos de código do Visual Studio.

Elemento SnippetType

Especifica como o Visual Studio insere o trecho de código.

<SnippetType>
    SurroundsWith/Expansion
<SnippetType>

Elementos pai

Descrição

SnippetTypes Element

Agrupa elementos SnippetType.

O valor de texto deve ser um dos seguintes valores:

  • SurroundsWith: permite que o trecho de código seja colocado em torno de uma parte do código selecionada.

  • Expansion: permite que o trecho de código seja inserido onde está o cursor.

  • Refactoring: especifica que o trecho de código é usado durante refatoração do Visual C#. Refactoring não pode ser usado em trechos de código personalizados.

Elemento SnippetTypes

Agrupa elementos SnippetType individuais. Se o elemento SnippetTypes não estiver presente, o trecho de código poderá ser inserido em qualquer lugar no código.

<SnippetTypes>
    <SnippetType>... </SnippetType>
    <SnippetType>... </SnippetType>
<SnippetTypes>

Elementos filho

Descrição

SnippetType Element

Elemento opcional. Especifica como o Visual Studio insere o trecho de código no código. Pode ser que não haja nenhum ou mais de um elemento SnippetType em um elemento SnippetTypes.

Elementos pai

Descrição

Header Element

Especifica informações gerais sobre o trecho de código.

Elemento Title

Especifica o título do trecho de código. O título armazenado no elemento Title do trecho de código aparece no Selecionador de Trechos de Código e na descrição do trecho de código no Gerenciador de Trechos de Código.

<Title>
    Code Snippet Title
<Title>

Elementos pai

Descrição

Header Element

Especifica informações gerais sobre o trecho de código.

Um valor de texto é obrigatório. Esse texto especifica o título do trecho de código.

Elemento ToolTip

Descreve o valor esperado e o uso de um literal ou um objeto em um trecho de código, que o Visual Studio exibe em uma Dica de Ferramenta quando inserir o trecho de código em um projeto. O texto Dica de Ferramenta é exibido quando o mouse passa sobre o literal ou objeto depois que o trecho de código foi inserido.

<ToolTip>
    ToolTip description
</ToolTip>

Elementos pai

Descrição

Literal Element

Define os campos de literal do trecho de código que você pode editar.

Object Element

Define os campos de objeto do trecho de código que você pode editar.

Um valor de texto é obrigatório. Esse texto especifica a descrição da Dica de Ferramenta a ser associada ao objeto ou literal no trecho de código.

Elemento Type

Especifica o tipo do objeto. O elemento Object é usado para identificar um item que é exigido pelo trecho de código, mas que provavelmente será definido fora do trecho em si. Por exemplo, os controles do Windows Forms, os controles do ASP.NET, as instâncias do objeto e as instâncias do tipo devem ser declarados como objetos. As declarações de objeto exigem que um tipo seja especificado, o que é feito com o elemento Type.

<Type>
    Type
</Type>

Elementos pai

Descrição

Object Element

Define os campos de objeto do trecho de código que você pode editar.

Um valor de texto é obrigatório. Esse texto especifica o tipo do objeto.

Elemento Url

Especifica uma URL que fornece mais informações sobre o assembly referenciado.

Dica

O elemento Url tem suporte apenas em projetos do Visual Basic.

<Url>
    www.microsoft.com
</Url>

Elementos pai

Descrição

Reference Element

Especifica as referências de assembly exigidas pelo trecho de código.

Um valor de texto é obrigatório. Esse texto especifica uma URL com mais informações sobre o assembly referenciado. Essa URL é exibida quando a referência não pode ser adicionada ao projeto.

Consulte também

Tarefas

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

Outros recursos

Trechos de código