Ferramenta Comentário automático

Consulte também

A ferramenta Comentário automático do IDE permite que você determine se os comentários de Javadoc do código-fonte são válidos e também edite ou mesmo crie os comentários quando necessário. As entidades do código-fonte com comentários de Javadoc estão listadas no painel esquerdo, e as marcas e os comentários são exibidos no painel direito.

Para abrir a ferramenta Comentário automático, clique com o botão direito do mouse no arquivo que você deseja documentar na janela Projetos ou Editor de código e escolha Ferramentas > Cometário automático no menu contextual.

Barra de ferramentas de filtro

A barra de ferramentas de filtro permite que você controle as classes e os membros que são exibidos na ferramenta Comentário automático O quadro abaixo descreve os botões na barra de ferramentas

Botão da
Barra de ferramentas
Descrição
Ícone de OK Alterna a exibição para classes e membros com comentários de Javadoc completos
Ícone de erro Alterna a exibição para classes e membros com comentários de Javadoc parciais e errôneos
Ícone de ausente Alterna a exibição para classes e membros sem comentários de Javadoc
Ícone de público Alterna a exibição para métodos públicos
Ícone de pacote Alterna a exibição para métodos com acesso padrão
Ícone de protegido Alterna a exibição para métodos com acesso protegido
Ícone de privado Alterna a exibição para métodos privados

Botões de comando

Se uma entidade tiver um comentário do Javadoc ausente ou incorreto, você pode clicar em um botão de comando para editar o comando. O quadro abaixo lista os botões de comando.

Se uma entidade tiver um comentário do Javadoc ausente ou incorreto, você pode clicar em um botão de comando para editar o comando. A lista abaixo descreve os botões de comando.

Texto do comentário Javadoc

Você pode criar ou editar o texto de um comentário do Javadoc no painel Texto do comentário Javadoc da ferramenta Comentário automático. A primeira frase do comentário deve ser uma descrição resumida da entidade declarada. O texto pode incluir elementos HTML (como <B> e <I>) para formatar a descrição. Elementos de cabeçalho (como <H1> e <H2>) são reservados para uso pela ferramenta do Javadoc. Você pode usar os botões de comando da janela para incluir os elementos HTML <B>, <I>, <U>, <CODE> e <PRE>, e o Javadoc {@link} na descrição. Por exemplo:

/**
* Retorna a classe deste <I>Objeto</I>.
* Java tem uma representação de tempo de execução para
* classes--um descritor do tipo classe--
* que o método getClass() retorna para
* qualquer Objeto.
*/

Não é necessário digitar os caracteres /** e */ ou os asteriscos à esquerda no cam po de texto Comentário Javadoc. Esses caracteres são incluídos automaticamente quando o IDE adiciona o comentário no código-fonte.

Marcas

Você cria ou edita as marcas de um comentário de Javadoc no painel Marcas da ferramenta Comentário automático. Uma marca Javadoc começa com o caractere @ seguido de uma palavra-chave especial. Marcas são sensíveis a maiúsculas minúsculas. Uma marca Javadoc permite que você gere informações automaticamente para a documentação da API. Por exemplo, nome do @autor adiciona uma entrada de autor com o nome especificado para a documentação gerada. Uma marca aparece no começo de uma linha (caso contrário é tratada como texto normal). Por convenção, marcas com o mesmo nome são agrupadas juntas. O comentário a seguir inclui quatro marcas Javadoc:

/**
* Uma classe que representa uma janela de tela.
* Por exemplo:
*    Window win = new Window(pai);
*    win.show();
*
* @autor  Haley J. Ryan
* @versão 1.3 00/08/08
* @consulte     java.awt.BaseWindow
* @consulte     java.awt.Button */

Para adicionar uma marca Javadoc ao comentário, clique em Novo, selecione uma marca Javadoc ou digite uma nova marca e clique em OK. A marca é adicionada no painel Marcas. No campo Descrição, digite o texto da marca. O texto pode incluir elementos HTML (como <B> e <I>) e a marca Javadoc in-line {@link}.

Consulte também
Inserindo comentários de Java no código-fonte

Notificações legais