A volte capita di accorgersi che un metodo non era stato pensato bene e che ci sono soluzioni alternative più efficienti. Non è conveniente, a questo punto, cancellare il metodo dalle successive versioni della classe, perché potrebbero esserci altre classi che lo utilizzano. La soluzione consiste nello sconsigliare l'utilizzo e di indicare la soluzione più efficiente. Per ottenere questo è possibile marcare il codice come deprecato (sconsigliato).
Dalla versione 1.5 di Java per deprecare un metodo si deve usare l'annotazione @Deprecated
, che può essere usata sulle classi, sui metodi o sugli attributi.
E' buona norma accompagnare l'annotazione un commento usando il tag @deprecated
(attenzione alla minuscola) di javadoc. Nel testo è opportuno specificare perchè il metodo viene deprecato e qual è l'alternativa da utilizzare.
1
2
3
4
5
6
7
8
9
|
/** * [...] * @deprecated use {@link #importTrade(Trade)} instead ... */ @Deprecated Long importTradeFromXML(String xml) { ... |
Per creare nei javadoc un collegamento ad un altro metodo viene utilizzato il tag @link
la cui sintassi è:
{@link package.class#member label}