Documentando nossos projetos
Por: RODRIGO D’AGOSTINI PELEIAS

Apresentação e aplicação do JavaDoc nos nossos projetos, e porque podemos nos beneficar do seu uso. Neste artigo, mostraremos brevemente como consultar o JavaDoc da API padrão da plataforma Java e enfatizaremos a criação de guias para os nossos projetos. Apresentaremos os elementos necessários para a criação da documentação a partir de um exemplo prático do dia-a-dia. Além disso, demonstraremos algumas boas práticas a serem adotadas ao comentar os nossos códigos-fontes, mostrando por fim o que devemos e como documentar, e como gerar o JavaDoc a partir dos comandos do JDK e pelas IDEs Eclipse e NetBeans.