Olá pessoal,
quando eu crio um javadoc para uma superclasse eu necessito criar também para suas subclasses? se tratando de uma classe abstrata dessas subclasses?
Javadoc para classe abstrata
J
4 Respostas
Olá pessoal,quando eu crio um javadoc para uma superclasse eu necessito criar também para suas subclasses? se tratando de uma classe abstrata dessas subclasses?
Precisa sim…adicionado o “pq” na documentação do motivo da extensão/especialização feita…
Pq se vc não fez nada de interessante da herança…a herança não deveria existir…
Eu sempre uso aquele recurso do Eclipse em que ele cria um comentário assim:
/*
* (non-Javadoc)
* @see br.com.pacote.ClasseMae#meuMetodo(java.lang.String)
*/
@Override
public String meuMetodo(String param) {
Dessa maneira fica a referência para o javadoc para a classe mãe, e logo abaixo do @see acrescento o que for necessário a respeito da classe filha especificamente.
Se quiser ter um Javadoc mesmo (caso o usuário da subclasse tenha que trabalhar com ela diretamente), é só acrescentar mais um * na primeira linha 
J
Legal galera, obrigado! Já serviu pra eu ter uma base, qualquer dúvida posto aqui.
Para não precisar redigitar o mesmo JavaDoc herdado vc coloca o seguinte comando:
/** {@inheritDoc} */
@Override
public synchronized void setIspb(Map<String, Ispb> colecao)
throws CacheException {
StringBuffer json = new StringBuffer();
json.append(xstream.toXML(colecao));
cache.set(COLECAO_ISPB, json);
}
Mesmo assim precisara adicionar a documentação das extensões e as possíveis alterações polimórficas…
Criado 17 de fevereiro de 2012
Ultima resposta 17 de fev. de 2012
Respostas 4
Participantes 3