Documentando as classes
Cada classe do seu código deve incluir um cabeçalho que declara que o código foi feito por você e que todo trecho de código utilizado de terceiros está corretamente identificado e referenciado (veja exemplo abaixo). Esse cabeçalho deve ser incluído logo no início da sua classe. Esse cabeçalho não vai aparecer na documentação produzida pelo Javadoc e serve apenas para você indicar que é o autor do código e de que está ciente das suas responsabilidades.
Toda classe também deve ter um comentário Javadoc descrevendo a classe (veja exemplo abaixo). Esse comentário Javadoc vem antes da palavra class. Este comentário vai aparecer na documentação gerada pelo javadoc. Dêem uma olhada no exemplo abaixo.
Código
/**
* Componente Curricular: Módulo Integrado de Programação
* Autor: <Seu nome>
* Data: <Data que fez a classe>
*
* Declaro que este código foi elaborado por mim de forma individual e
* não contém nenhum trecho de código de outro colega ou de outro autor,
* tais como provindos de livros e apostilas, e páginas ou documentos
* eletrônicos da Internet. Qualquer trecho de código de outra autoria que
* uma citação para o não a minha está destacado com autor e a fonte do
* código, e estou ciente que estes trechos não serão considerados para fins
* de avaliação. Alguns trechos do código podem coincidir com de outros
* colegas pois estes foram discutidos em sessões tutorias.
*/
package br.uefs.ecomp.oc.model;
import br.uefs.ecomp.oc.util.IList;
import br.uefs.ecomp.oc.util.Iterator;
import br.uefs.ecomp.oc.util.LinkedList;
/**
* Esta classe implementa o comportamento de um paciante. Portanto ela
* contém os atributos de um paciante como nome, endereço e telefone.
* Além disso, ela armazena uma referência para as sessões clinicas em
* que o paciente participou e para o prontuario do paciente.
*
* Exemplo de uso:
*
* Paciente paciente = new Paciente("id", "nome");
*
* @author <seu nome>
*
* @see br.uefs.ecomp.oc.util.IList
* @see br.uefs.ecomp.oc.model.Prontuario
*/
public class Paciente {
private String id;
private String nome;
private char sexo;
private String dataNascimento;
private String endereco;
private String telefoneFixo;
private String telefoneCelular;
private IList sessoes;
private Prontuario prontuario;
....
Caso vocês tenham problemas com palavras que contêm acentos. Vocês devem modificar o build.xml para que o javadoc produza os documentos html corretamente. Para isto, basta inserir os seguintes parametros no target que produz o javadoc: charset="utf8" docencoding="utf8"
Exemplo:
<target name="doc">
<mkdir dir="${doc}" />
<javadoc author="true" classpath="${classpath}" destdir="${doc}"
sourcepath="${source}" use="true"
version="true" windowtitle="odontoclinicas"
charset="utf8" docencoding="utf8">
<fileset dir="${source}" defaultexcludes="yes"/>
</javadoc>
</target>