Adicionando Javadoc a um projeto
Consulte também
Você pode criar documentação do Javadoc para uma classe do arquivo JAR disponível no IDE associando essa documentação ao arquivo JAR.
Se desejar ter acesso à documentação do JDK compilado através do IDE, consulte Adicionando Javadoc do JDK ao IDE
- Ao adicionar um projeto necessário a uma classpath do projeto, o Javadoc e as fontes necessárias do projeto também são adicionados automaticamente ao projeto.
Para adicionar Javadoc para um arquivo JAR:
- No menu principal, escolha Ferramentas > Gerenciador de bibliotecas.
- No painel esquerdo de Gerenciador de bibliotecas, selecione a biblioteca de projetos dentro da qual está localizado o arquivo JAR ao qual você deseja adicionar a documentação do Javadoc.
- Somente bibliotecas já registradas com o IDE são listadas na lista Bibliotecas de classes do Gerenciador de bibliotecas.
- Se o arquivo JAR ao qual você deseja adicionar a documentação do Javadoc não tiver sido já adicionado a uma biblioteca registrada, crie uma nova biblioteca vazia usando o botão Nova biblioteca. Em seguida, na aba Classpath, clique em Adicionar JAR/pasta e especifique o local do arquivo JAR que contém os arquivos de classes compiladas.
Observações:
- Você também pode associar o Javadoc com o arquivo JAR usando a janela Propriedades do projeto. Entretanto, fazer isso cria a associação somente para esse projeto. Para abrir a caixa de diálogo Propriedades do projeto, clique com o botão direito do mouse no nó do projeto e escolha Propriedades. Selecione o nó de bibliotecas no painel Categorias. Em seguida, selecione o JAR com o qual deseja associar o Javadoc e clique em Editar. Você pode especificar os códigos-fonte a serem associados.
- Uma biblioteca de classes pode conter múltiplos arquivos JAR, assim como documentação Javadoc e código-fonte.
- Na guia Javadoc, clique em Adicionar ZIP/pasta e especifique o local dos arquivos do Javadoc.
- Clique em OK para sair de Gerenciador de bibliotecas.
O IDE adiciona os arquivos JAR e os arquivos Zip da documentação do Javadoc selecionados à biblioteca especificada e registra automaticamente a documentação em cada projeto que tiver esse arquivo JAR na classpath.
- Ao criar uma biblioteca de classes Java para um único arquivo JAR, você pode simplesmente adicionar o arquivo JAR ao classpath do projeto para tornar disponíveis o Javadoc e o código-fonte associados. Se a biblioteca Java contiver múltiplos arquivos JAR, no entanto, você deve adicionar a própria biblioteca ao classpath. A adição da biblioteca ao classpath também facilita o compartilhamento do projeto com outros desenvolvedores.
- Consulte também
- Gerenciando o classpath
- Anexando um código-fonte a um arquivo JAR
- Exibindo a documentação do Javadoc
Notificações legais