(java) javadoc

[abcd1000]

Ho scritto un commento per un metodo di una classe java

alcuni dei tag sono
@param
@return
@since

Bene, supponiamo che oggi devo modificare il metodo (o perchè ho trovato un bug o perchè deve fare più cose)

Che tag devo usare per segnalare che il metodo è cambiato? il tag @version si usa solo per classi e interfacce non per i metodi come ho letto qui:

http://java.sun.com/j2se/javadoc/writingdoccomments/


quindi cosa uso?

[LeleFT]

Uno dei motivi per cui è stata inventata la programmazione Object Oriented è proprio per evitare di far conoscere al mondo i dettagli dell'implementazione di un oggetto: l'utente deve fregarsene di come è stato implementato il metodo o di come è stato modificato, l'importante è che l'interfaccia non sia cambiata.

E qui entra in gioco la versione: se ci sono delle versioni differenti, che magari differiscono per l'interfaccia, vanno proposte entrambe, altrimenti non si fa menzione di niente, se non avvisare gli utenti del fatto che ci sono state delle modifiche (appunto, il numero di versione).

Altrimenti esiste sempre la possibiiltà di deprecare il metodo...

Se devi informare delle modifiche, non credo che esista un tag particolare... basta che lo espliciti nella descrizione.

Ciao.