Come funziona esattamente @param - Java

Question

Come funziona l'annotazione @param?

Se avessi qualcosa di simile:

/* 
*@param testNumber; 
*/ 

int testNumber = 5; 
if (testNumber < 6) { 
    //Something 
} 

Come sarebbe il @param influenzare il testNumber? Influisce anche sul numero di test?

Grazie. Fammi sapere se l'ho usato sbagliato.

Answer 1

@param non influisce sul numero. Credo che sia solo per fare javadoc.

Maggiori info su javadoc: http://www.oracle.com/technetwork/java/javase/documentation/index-137868.html

Answer 2

@param è un commento speciale formato utilizzato da javadoc per generare la documentazione. è usato per denotare una descrizione del parametro (o dei parametri) che un metodo può ricevere. c'è anche @return e @see usato per descrivere i valori di ritorno e le informazioni correlate, rispettivamente:

http://www.oracle.com/technetwork/java/javase/documentation/index-137868.html#format

ha, tra le altre cose, questo:

/** 
* Returns an Image object that can then be painted on the screen. 
* The url argument must specify an absolute {@link URL}. The name 
* argument is a specifier that is relative to the url argument. 
* <p> 
* This method always returns immediately, whether or not the 
* image exists. When this applet attempts to draw the image on 
* the screen, the data will be loaded. The graphics primitives 
* that draw the image will incrementally paint on the screen. 
* 
* @param url an absolute URL giving the base location of the image 
* @param name the location of the image, relative to the url argument 
* @return  the image at the specified URL 
* @see   Image 
*/ 
public Image getImage(URL url, String name) { 

Answer 3

@param non influirà testNumber.It è un Javadoc commento - utilizzato per generare documentazione. È possibile inserire un commento Javadoc immediatamente prima di una classe, campo, metodo, costruttore o interfaccia come @param, @return. Generalmente inizia con "@" e deve essere la prima cosa sulla linea.

Il vantaggio dell'utilizzo di @param è: - Creando classi Java semplici che contengono attributi e alcuni tag Javadoc personalizzati, si consente a tali classi di essere utilizzate come una semplice descrizione dei metadati per la generazione del codice.

/* 
     *@param testNumber 
     *@return integer 
    */ 
    public int main testNumberIsValid(int testNumber){ 

     if (testNumber < 6) { 
      //Something 
     } 
    } 

Ogni volta che nel codice, se si riutilizza il metodo testNumberIsValid, IDE vi mostrerà i parametri del metodo accetta e il tipo di metodo di tornare.

Answer 4

È fondamentalmente un commento. Come sappiamo, un numero di persone che lavorano allo stesso progetto deve avere conoscenza delle modifiche al codice. Stiamo facendo alcune note nel programma sui parametri.