Wie genau funktioniert @param - Java

Question

Wie funktioniert die Annotation @param?

Wenn ich so etwas wie dieses hatte:

/* 
*@param testNumber; 
*/ 

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

Wie würde die @param beeinflussen die testNumber? Beeinflusst es sogar die testNumber?

Danke. Lass es mich wissen, wenn ich es falsch benutzt habe.

Answer 1

@param wird die Nummer nicht beeinflussen. Ich glaube, es ist nur für Javadocs.

Mehr zu javadoc: http://www.oracle.com/technetwork/java/javase/documentation/index-137868.html

Answer 2

@param ist ein spezielles Format Kommentar verwendet von javadoc Dokumentation zu erzeugen. Es wird verwendet, um eine Beschreibung des Parameters (oder der Parameter) zu bezeichnen, den eine Methode empfangen kann. es gibt @return und @see auch jeweils Rückgabewerte und die zugehörigen Informationen zu beschreiben:

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

hat unter anderem diese:

/** 
* 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 hat keinen Einfluss auf testNumber.It ein Javadoc ist Kommentar - dh zum Generieren der Dokumentation verwendet. Sie können einen Kommentar Javadoc direkt vor einer Klasse, einem Feld, einer Methode, einem Konstruktor oder einer Schnittstelle eingeben, z. B. @param, @return. Im Allgemeinen beginnt mit '@' und muss das erste Ding auf der Linie sein.

Der Vorteil der Verwendung von @param ist: - Durch das Erstellen einfacher Java-Klassen, die Attribute und einige benutzerdefinierte Javadoc-Tags enthalten, ermöglichen Sie diese Klassen als einfache Metadatenbeschreibung für die Codegenerierung.

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

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

Jedes Mal, wenn in Ihrem Code, wenn Sie testNumberIsValid Methode wiederverwenden, werden IDE zeigen Sie die Parameter der Methode akzeptiert und die Art des Verfahrens zurück.

Answer 4

Es ist im Grunde ein Kommentar. Wie wir wissen, müssen einige Personen, die an demselben Projekt arbeiten, Kenntnisse über die Codeänderungen besitzen. Wir machen einige Notizen im Programm über die Parameter.