Gerando comentários de Javadoc no código-fonte

Consulte também

Você também pode usar dicas do editor para gerar automaticamente os comentários de Javadoc básicos para elementos de código em seus arquivos de código-fonte. Os comentários gerados incluem marcas obrigatórias do elemento de código específico. Por exemplo, se um método usa um parâmetro, uma marca @param é inserida. Você também pode usar dicas para gerar correções nos documentos de Javadoc, como quando os comentários contêm marcas incorretas.

Você é notificado de uma dica do editor por um ícone de lâmpada que aparece na margem esquerda do Editor de código-fonte. Você pode ler a dica clicando no ícone de lâmpada ou pressionando Alt-Enter. Você pode gerar o código sugerido pela dica clicando na dica ou pressionando Enter.

As dicas para geração de Javadoc são desativadas por padrão.

Para ativar as dicas de comentários de Javadoc:

  1. Escolha Ferramentas > Opções.
  2. Clique no botão Código Java no alto da janela Opções.
  3. Clique na aba Dicas.
  4. Marque a caixa de verificação Javadoc.

Por padrão, as dicas de Javadoc funcionam com elementos protegidos e elementos públicos. Se você gostaria de alterar o escopo das dicas, expanda o nó Javadoc e selecione um dos subnós. Em seguida, escolha o botão de rádio do escopo ao qual você gostaria de aplicar as dicas.

Para obter mais informações sobre marcas do Javadoc, consulte:

Para obter informações sobre como escrever comentários do Javadoc, consulte:

Consulte também
Gerando documentação do Javadoc
Adicionando a biblioteca de Javadoc a um projeto

Notificações legais