Qual o correto?

8 respostas
rogeriosantos77

Srs, Imaginem que eu possuo uma classe com um método e neste método eu coloquei um javadoc.
Esta classe implementa uma interface que te este método, porém na interface não tem o javadoc.

O correto seria ter o javadoc somente na interface, somente no método implementado ou nos dois ?

8 Respostas

nbluis

Na interface apenas.

nosredna

Bom eu acho que so na interface, ja que a classe esta implementando. algo que ja tem uma finalidade definida, so não tem a forma ainda.

peczenyj

Coloca nos dois :wink:

B

Pois é, concordo, interface é um contrato, então a classe que implementa tem que segui-lo, logo só na interface.

ChronoTrigger

Na minha opinião nos 2, mas no caso de um ejb só será visivel para um cliente o que estiver na interface.

Para boa documentação coloque nos 2, já que ao ler a classe não será necessário abrir a inteface para saber o que o método faz.

B

ChronoTrigger:
Na minha opinião nos 2, mas no caso de um ejb só será visivel para um cliente o que estiver na interface.

Para boa documentação coloque nos 2, já que ao ler a classe não será necessário abrir a inteface para saber o que o método faz.

Haaa… hoje com as ferramentas de javadoc, ele copia o que está na interface e coloca no javadoc da classe… vide
http://java.sun.com/javase/6/docs/api/java/util/ArrayList.html#remove(java.lang.Object)

ChronoTrigger

Dependo, no javadoc do método da classe poderia colocar detalhes da implementação.

:wink:

ViniGodoy

ChronoTrigger:
Dependo, no javadoc do método da classe poderia colocar detalhes da implementação.
;)

Só se isso for muito relevante. Caso contrário, é também uma quebra de encapsulamento.

Criado 31 de julho de 2008
Ultima resposta 31 de jul. de 2008
Respostas 8
Participantes 7