example - Cómo Exactamente Funciona @param-Java

java docs tags

Question

¿Cómo funciona la anotación @param ?

Si tuviera algo como esto:

/* 
*@param testNumber;
*/

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

¿Cómo afectaría el @param al número de prueba? ¿Incluso afecta el número de prueba?

Gracias. Déjame saber si lo usé mal.

Answer 1

Es básicamente un comentario. Como sabemos, varias personas que trabajan en el mismo proyecto deben conocer los cambios en el código. Estamos haciendo algunas notas en el programa sobre los parámetros.

Answer 2

@param es un comentario de formato especial utilizado por javadoc para generar documentación. se utiliza para denotar una descripción del parámetro (o parámetros) que un método puede recibir. también se utilizan @return y @see para describir valores de retorno e información relacionada, respectivamente:

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

tiene, entre otras cosas, esto:

/**
 * 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 no afectará a testNumber. Es un comentario de Javadoc , es decir, se utiliza para generar documentación. Puede poner un comentario Javadoc inmediatamente antes de una clase, campo, método, constructor o interfaz como @param , @return . Generalmente comienza con '' @ '' y debe ser lo primero en la línea.

La ventaja de usar @param es: - Al crear clases Java simples que contienen atributos y algunas etiquetas Javadoc personalizadas, permite que esas clases sirvan como una descripción de metadatos simple para la generación de código.

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

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

Siempre que en su código, si reutiliza el método testNumberIsValid, IDE le mostrará los parámetros que el método acepta y el tipo de método de devolución.

Answer 4

@param no afectará el número. Creo que es solo para hacer javadocs.

Más información sobre javadoc: http://www.oracle.com/technetwork/java/javase/documentation/index-137868.html