Anotación @param en Java

En Java, las anotaciones son las etiquetas que representan los metadatos, que se adjuntan con una clase, interfaz, métodos, etc, para indicar algún tipo especial de información adicional que pueden utilizar JVM y el compilador de Java.

La anotación @param es un comentario de formato especial utilizado por el javadoc que genera documentación.

En este tutorial, discutiremos cómo funciona la anotación @param en Java.

Como se mencionó anteriormente, @param es un tipo especial de comentario de formato utilizado por el javadoc, que genera la documentación. Denota una descripción del parámetro (o múltiples parámetros) que puede recibir un método.

También hay anotaciones como @return y @see para describir los valores devueltos y la información relacionada.

Si se usa en cualquier método específicamente, esta anotación no afectará el método de su funcionamiento de ninguna manera. Solo se usa para crear documentación de ese método en particular. Podemos poner esta anotación justo antes de una clase, método, campo, constructor, interfaz, etc.

La ventaja de usar esta anotación es que al usarla, permitimos que las clases Java simples, que pueden contener atributos y algunas etiquetas javadoc personalizadas, sirvan como descripciones de metadatos simples para la generación de código.

Por ejemplo,

/*
 *@param number
 *@return integer
 */
public int main number(int num) {
  // if number is less than 5, square it
  if (num < 5) {
    num = num * num;
  } else {
    // else add the number to itself
    num = num + num;
  }
  return num;
}

En el ejemplo anterior, el método number() actuará como metadatos para el resto del código. Siempre que el código reutiliza este método, IDE muestra los parámetros que acepta este método. En este caso, se acepta un parámetro, y ese es un número entero llamado num. Además, el tipo de retorno del método, que en este caso es int.