Annotation @param em Java

Em Java, as anotações são as tags que representam os metadados, que são anexados a uma classe, interface, métodos, etc., para indicar algum tipo especial de informação adicional que pode ser usada pelo JVM e pelo compilador Java.

A anotação @param é um comentário de formato especial usado pelo javadoc que gera a documentação.

Neste tutorial, discutiremos como a anotação @param funciona em Java.

Como mencionado acima, @param é um tipo especial de comentário de formato usado pelo javadoc, que gera a documentação. Ele denota uma descrição do parâmetro (ou parâmetros múltiplos) que um método pode receber.

Existem também anotações como @return e @ver para descrever os valores de retorno e informações relacionadas.

Se usada em qualquer método específico, esta anotação não afetará o método de seu funcionamento de forma alguma. Ele é usado apenas para criar documentação desse método específico. Podemos colocar essa anotação logo antes de uma classe, método, campo, construtor, interface, etc.

A vantagem de usar essa anotação é que, ao usá-la, permitimos que as classes Java simples, que podem conter atributos e algumas tags javadoc personalizadas, sirvam como descrições de metadados simples para a geração de código.

Por exemplo,

/*
 *@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;
}

No exemplo acima, o método number() atuará como metadados para o resto do código. Sempre que o código reutiliza esse método, o IDE mostra os parâmetros que esse método aceita. Nesse caso, um parâmetro é aceito, e esse é um número inteiro denominado num. Além disso, o tipo de método de retorno, que neste caso é int.