Annotation @param en Java

En Java, les annotations sont les balises qui représentent les métadonnées, qui sont attachées à une classe, une interface, des méthodes, etc., pour indiquer un type spécial d’informations supplémentaires pouvant être utilisées par JVM et le compilateur Java.

L’annotation @param est un commentaire de format spécial utilisé par le javadoc qui génère la documentation.

Dans ce tutoriel, nous verrons comment fonctionne l’annotation @param en Java.

Comme mentionné ci-dessus, @param est un type spécial de commentaire de format utilisé par le javadoc, qui génère la documentation. Il désigne une description du paramètre (ou de plusieurs paramètres) qu’une méthode peut recevoir.

Il existe également des annotations telles que @return et @see pour décrire les valeurs de retour et les informations associées.

Si elle est utilisée dans une méthode spécifique, cette annotation n’affectera en aucune manière la méthode de son fonctionnement. Il est simplement utilisé pour créer la documentation de cette méthode particulière. Nous pouvons mettre cette annotation juste avant une classe, une méthode, un champ, un constructeur, une interface, etc.

L’avantage d’utiliser cette annotation est qu’en l’utilisant, nous permettons aux classes Java simples, qui peuvent contenir des attributs et des balises javadoc personnalisées, de servir de descriptions de métadonnées simples pour la génération de code.

Par exemple,

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

Dans l’exemple ci-dessus, la méthode number() servira de métadonnées pour le reste du code. Chaque fois que le code réutilise cette méthode, IDE affiche les paramètres que cette méthode accepte. Dans ce cas, un seul paramètre est accepté, c’est un entier nommé num. Aussi, le type de retour de la méthode, qui dans ce cas est int.