web-dev-qa-db-fra.com

Comment fonctionne exactement @param - Java

Comment fonctionne l'annotation @param?

Si j'avais quelque chose comme ça:

/* 
*@param testNumber;
*/

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

Comment le @param affecterait-il le numéro de test? Cela affecte-t-il même le numéro de test?

Merci. Faites-moi savoir si je l'ai mal utilisé.

javaparam
20
user2228462

@param n'affectera pas le nombre. C'est juste pour faire des javadocs.

Plus sur javadoc: http://www.Oracle.com/technetwork/Java/javase/documentation/index-137868.html

14
Kirsten Koa

@param est un commentaire de format spécial utilisé par javadoc pour générer de la documentation. il est utilisé pour désigner une description du paramètre (ou des paramètres) qu'une méthode peut recevoir. Il existe également @return et @see utilisés pour décrire les valeurs de retour et les informations associées, respectivement:

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

a, entre autres, ceci:

/**
 * 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 n'affectera pas testNumber.Il s'agit d'un commentaire Javadoc - c'est-à-dire utilisé pour générer de la documentation . Vous pouvez mettre un commentaire Javadoc immédiatement avant une classe, un champ, une méthode, un constructeur ou une interface telle que @param, @return ..____. commence par ' @ ' et doit être la première chose à faire.

L'avantage d'utiliser @param est: - En créant de simples classes Java contenant des attributs et des balises Javadoc personnalisées, vous autorisez ces classes à servir de description de métadonnées simples pour la génération de code.

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

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

Si vous réutilisez la méthode testNumberIsValid dans votre code, IDE affiche les paramètres acceptés par la méthode et renvoie le type de la méthode.

3
user2354660

C'est fondamentalement un commentaire. Comme nous le savons, un certain nombre de personnes travaillant sur le même projet doivent avoir une connaissance des modifications apportées au code. Nous prenons quelques notes dans le programme sur les paramètres.

0
Rahul