Questa domanda & le sue risposte sono utili ma non sufficienti per il mio problema.
La mia domanda è se voglio aggiungere un javadoc come @Deprecated A partire dalla versione x.y, sostituito da {@link SomeClass} nel javadoc del mio file corrente, quindi quale dovrebbe essere la versione no. al posto di x.y ??
Lascia che la mia versione attuale sia 1.2 & dopo il controllo del CVS sarà 1.3
Nessuno tranne te si preoccupa dei numeri di revisione CVS; sono un artefatto interno del meccanismo che usi (se hai usato Git, gli ID di revisione sarebbero interamente diversi e senza una sequenza ovvia).
Invece, dovresti definire le versioni in termini di versioni dove dici "questa è una configurazione del codice che ha senso usare nel suo complesso", ed è proprio quelle versioni che dovresti fare riferimento alla documentazione, specialmente per cose come le avvertenze sulla deprecazione. Dopotutto, saranno quelle versioni che i consumatori dell'API - le persone che saranno i consumatori degli avvisi di deprecazione e il software che creano - vedranno. In termini di sistema di controllo delle revisioni, le versioni di rilascio sono il genere di cose che di solito è meglio modellare con un tag o un'etichetta.
Se non hai ancora fatto un rilascio, non devi deprecare nulla. Se hai una versione precedente, l'avviso di rimozione dovrebbe menzionare la versione di rilascio successiva . (Non dovrebbe menzionare la versione appena rilasciata, che dovrebbe essere considerata un artefatto statico.)
Sembra che tu stia utilizzando la revisione del controllo della versione come parte del tuo numero di versione. Finché il tuo numero di revisione VCS aumenta (CVS lo fa) questa non è una pessima idea.
Detto questo, dovresti avere almeno un paio di numeri di ordine superiore nel numero di revisione.
es. <major version>.<sprint number>.<CVS revision number>
Invece di <major version>.<CVS revision number>
In questo modo, puoi semplicemente dare la parte <major version>.<sprint number> nei commenti javadoc - sostituiscono comunque il numero di revisione CVS. Se non utilizzi gli sprint, puoi semplicemente utilizzare un numero arbitrario che si incrementa ogni volta che cambi l'API o ogni nuova funzione.
Leggi altre domande sui tag code-quality java comments deprecation javadocs