Gabaritos

A página de preferências Gabaritos permite criar novos gabaritos e editar gabaritos existentes. Um gabarito é uma comodidade para o programador que pode inserir rapidamente padrões de código fonte que reocorrem com freqüência.

Os seguintes botões permitem manipulação e configuração dos gabaritos:

Ação

Descrição

Novo...

Abre um diálogo para criar um novo gabarito.

Editar...

Abre um diálogo para editar o gabarito selecionado atualmente.

Remover

Remove todos os gabaritos selecionados.

Importar...

Importa gabaritos do sistema de arquivos.

Exportar...

Exporta todos os gabaritos selecionados para o sistema de arquivos.

Exportar Tudo...

Exporta todos os gabaritos para o sistema de arquivos.

Ativar Tudo

Ativa todos os gabaritos.

Desativar Tudo

Desativa todos os gabaritos.

Utilizar Formatador de Código

Se ativado, o modelo será formatado de acordo com as regras de formatação de código especificadas nas preferências Preferências do Formatador de Código, antes da inserção. Caso contrário, o gabarito será inserido como está, mas alinhado corretamente.

Diálogo Gabarito

A criação de um novo gabarito e a edição de um gabarito existente utiliza o mesmo diálogo, descrito abaixo.

Aparecem os seguintes campos e botões no diálogo:

Opção

Descrição

Name

O nome do gabarito.

Contexto

O contexto determina onde o gabarito pode ser utilizado e o conjunto de variáveis de gabarito predefinidas disponível.

Java
O contexto Java
Javadoc
O contexto Javadoc

Inserir Automaticamente

Se selecionado, o assistente de código inserirá automaticamente o gabarito se ele for a única proposta disponível na posição do sinal de interpolação.

Descrição

Uma descrição do gabarito, que é exibido ao usuário ao escolher o gabarito.

Padrão

O padrão do gabarito.

Inserir Variáveis...

Exibe uma lista de variáveis predefinidas específicas do contexto.

Variáveis de Gabarito

Ambos os contextos, Java e Javadoc, definem as seguintes variáveis:

Variável

Descrição

${cursor}

Especifica a posição do cursor quando este deixa o modo de edição do gabarito. Isto é útil quando o cursor tem que pular para outro local, que não o fim do gabarito ao deixar o modo de edição do gabarito.

${date}

Determina a data atual.

${dollar}

Resulta no símbolo de dólar '$'.

Opcionalmente, podem ser utilizados dois símbolos de dólar: '$$'.

${enclosing_method}

Resulta no nome de inclusão.

${enclosing_method_arguments}

Resulta em uma lista, separada por vírgulas, de nomes de argumentos do método de inclusão. Esta variável pode ser útil na geração de instruções de log para vários métodos.

${enclosing_package}

Resulta no nome do pacote de inclusão.

${enclosing_project}

Resulta no nome do projeto de inclusão.

${enclosing_type}

Resulta no nome do tipo de inclusão.

${file}

Resulta no nome do arquivo.

${line_selection}

Avalia o conteúdo de todas as linhas selecionadas atualmente.

${primary_type_name}

Resulta no tipo primário do nome da unidade de compilação atual.

${return_type}

Resulta no tipo de retorno do método de inclusão.

${time}

Resulta no horário atual.

${user}

Resulta no nome de usuário.

${word_selection}

Resulta no conteúdo da seleção de texto atual.

${year}

Resulta no ano atual.

O contexto Java também define as seguintes variáveis:

Variável

Descrição

${array}

Resulta em uma sugestão para um nome de matriz declarado.

${array_element}

Resulta em uma sugestão para um nome de elemento de uma matriz declarada.

${array_type}

Resulta em uma sugestão para o tipo de elemento de uma matriz declarada.

${collection}

Resulta em uma sugestão para uma coleta declarada que implementa java.util.Collection.

${index}

Resulta em uma sugestão para um iterador de índice da matriz não declarada.

${iterator}

Resulta em uma sugestão para um iterador de coleta não declarada.

${iterable}

Resulta em uma proposta para um nome declarado que pode ser repetido.

${iterable_element}

Resulta em uma proposta para um nome de elemento de uma repetição declarada.

${iterable_type}

Resulta em uma proposta para o tipo de elemento de uma repetição declarada.

${todo}

Resulta em uma proposta para a tag da tarefa padrão especificada atualmente.

Conceitos Relacionados

Gabaritos

Tarefas Relacionadas

Utilizando Gabaritos
Gravando seus próprios gabaritos

Referência Relacionada

Assistente de Conteúdo Java
Preferências da Tag de Tarefa
Preferências de Gabaritos de Código
Preferências de Estilo de Código