Commentaires sur le bloc Java

En Java, nous utilisons des commentaires pour améliorer la lisibilité du code Java en fournissant des explications et des informations supplémentaires sur le code, aidant ainsi à maintenir le code et à trouver facilement les bogues et les erreurs. Lors de la compilation du code Java, le compilateur exclut complètement le texte et les instructions dans les commentaires.

Nous discuterons des commentaires de bloc en Java dans ce tutoriel.

Le commentaire de bloc est utilisé pour commenter plusieurs lignes de code en même temps. Nous utilisons /* et */ pour insérer des blocs de commentaires. Les commentaires de bloc peuvent s’étendre sur plusieurs lignes ou être insérés dans une instruction de code. Seul le texte vu entre les délimiteurs de commentaires est considéré comme la remarque et n’est pas pris en compte lors de la compilation.

Par exemple,

public class multilinecomment {
  public static void main(String[] args) {
    /* we have declared an integer n having value 007
    and a floating point variable z
    storing value of pi. */
    int n = 007;
    double z = 3.14;
    System.out.println(n);
    System.out.println(z);
  }
}

Production:

7
3.14

Il existe un autre type de commentaire multiligne disponible en Java. Pour cela, nous utilisons les /** et */ pour encadrer les commentaires de la documentation. Ceci est utilisé pour définir les API de documentation formelle de vos programmes qui sont créés par l’outil javadoc. Le javadoc est un outil qui analyse les déclarations et les commentaires de la documentation dans une collection de fichiers sources et génère une collection de pages HTML qui décrivent les classes, interfaces, constructeurs, méthodes et champs.

Par exemple,

public class javadoccomment {
  /**  multi() method returns multiplication of numbers.*/
  public static int multi(int a, int b) {
    return a * b;
  }

  /**  addition() method returns addition of numbers.*/
  public static int addition(int a, int b) {
    return a + b;
  }

  /**  subtract() method returns subtraction of numbers.*/
  public static int subtract(int a, int b) {
    return a - b;
  }
  public static void main(String[] args) {}
}

Lorsque nous compilons le code ci-dessus par l’outil javac, nous obtenons javadoccomment.java, puis un fichier HTML est créé pour la classe javadoccomment. Ouvrez le fichier HTML donné et regardez le commentaire de documentation pour la classe javadoccomment.