it-swarm.com.de

Wie funktioniert @param genau - Java

Wie funktioniert die Annotation @param?

Wenn ich so etwas hatte:

/* 
*@param testNumber;
*/

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

Wie wirkt sich der @param auf die testNumber aus? Betrifft es sogar die testNumber?

Vielen Dank. Lass mich wissen, wenn ich es falsch angewendet habe.

20
user2228462

@param beeinflusst die Nummer nicht. Es ist nur für die Herstellung von Javadocs.

Weitere Informationen zu Javadoc: http://www.Oracle.com/technetwork/Java/javase/documentation/index-137868.html

14
Kirsten Koa

@param ist ein spezielles Formatkommentar, das von javadoc zur Erstellung von Dokumentation verwendet wird. es bezeichnet eine Beschreibung des Parameters (oder der Parameter), die eine Methode empfangen kann. Es gibt auch @return und @see, um Rückgabewerte bzw. zugehörige Informationen zu beschreiben:

http://www.Oracle.com/technetwork/Java/javase/documentation/index-137868.html#format

hat unter anderem Folgendes:

/**
 * 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) {
26
rmalchow

@param wirkt sich nicht auf testNumber aus. Es handelt sich um einen Javadoc-Kommentar - dh zur Erstellung von Dokumentation . Sie können einen Javadoc-Kommentar direkt vor einer Klasse, einem Feld, einer Methode, einem Konstruktor oder einer Schnittstelle wie @param, @return ..__ beginnt mit ' @ ' und muss das erste sein, was in der Zeile steht.

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

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

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

Wenn Sie in Ihrem Code die testNumberIsValid-Methode wiederverwenden, zeigt IDE die von der Methode akzeptierten Parameter und den Rückgabetyp der Methode an.

3
user2354660

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

0
Rahul