2013-08-01 8 views

risposta

9

Il tag @SINCE dovrebbe essere utilizzata per definire quale versione è stato aggiunto il metodo, classe, ecc Questo è il suggerimento ad altri sviluppatori che dovrebbero si aspettano il metodo solo quando sono in esecuzione su una particolare versione del pacchetto. Prenderò in considerazione queste importanti parti della documentazione se stai spedendo il tuo codice come libreria destinata a per l'utilizzo da parte di qualcun altro.

/** 
* @author Firstname Lastname <address @ example.com> 
* @version 1.6  (current version number of program) 
* @since  1.5  (the version of the package this class was first added to) 
*/ 

Per ulteriori informazioni visitare:

http://en.wikipedia.org/wiki/Javadoc

javadoc: @version and @since

+0

grazie, sono stato confuso da quando sul wiki, l'esempio fornito era una versione simile a una data di un pacchetto! – Don

+0

Wikipedia non è un riferimento normativo. Utilizzare il materiale di riferimento fornito. – EJP

3

Il tag @SINCE non viene utilizzato per specificare la data piuttosto è utilizzato per fornire informazioni sull'ultimo informazioni sulla versione

/**  
* @since 1.7 
*/ 
2

@SINCE 1.1

poiché è seguita da un numero che indica una sorta di ID di versione. Qualsiasi formato farebbe ma formato NN è preferito

1

@since annotazione è usato per descrivere quando la funzionalità prima esisteva, è il numero di versione.

1

Come noto, @Since viene utilizzato per indicare la versione che avvia alcune implementazioni.

@Since 1.0 // meaning is this method start from version 1.0 
Problemi correlati