Java >> Tutoriel Java >  >> Java

Différents types de commentaires en programmation Java

Java

En Java, des "Commentaires" sont donnés pour les instructions qui ne sont pas exécutées par le compilateur et l'interpréteur au moment de l'exécution. Nous pouvons utiliser des commentaires pour afficher les informations sur les variables, les classes, les méthodes et sur toute opération/logique.

Il est également utilisé pour masquer une ligne, une instruction ou tout code particulier dans le programme (que vous ne souhaitez pas exécuter et que vous souhaitez conserver pour référence future ).

Types de commentaires en Java

Il existe trois types de commentaires en Java,

  1. Commentaire sur une seule ligne
  2. Commentaire multiligne
  3. Commentaire sur la documentation

1. Commentaire sur une seule ligne (//)

Il est représenté par une double barre oblique (//) et utilisé pour commenter une seule ligne, le texte qui est écrit après ces caractères (//) ne sera pas exécuté par le compilateur.

Syntaxe : 

// this line will not be executed

2. Commentaires multi-lignes (/*...*/)

Il est utilisé pour commenter plusieurs lignes dans le programme, car parfois nous devons expliquer/écrire plus de lignes qu'une seule ligne. Donc, à cette fin, nous devons utiliser un commentaire multi-lignes. Ceux-ci sont représentés par /* et */

Syntaxe : 

/*
Below code is used to create an employee class, this code is written by me 
on 27 Nov 2017. The code has been tested successfully.
Etc.
*/

3. Commentaire sur la documentation (/**...*/)

Dans les commentaires de documentation, nous pouvons utiliser la documentation de notre code source, en gros, il est utilisé pour décrire un code particulier, une description de fonction, etc.

Lorsque nous utilisons un commentaire de documentation, cela devient une partie de 'Javadoc' , et l'outil Javadoc sera utilisé pour cela.

Structure pour commentaire Javadoc

/**
    Paragraph description
    Tag labels
    @param  ...
    @return ...
    @author ...
    @throws ...
*/

Un exemple avec un commentaire de documentation 

/**
* This is a simple program to print Hello world!
*
* @author	Yamini Rawat
* @since	27/11/2017
* @reviewer	Alvin
*/
public class HelloWorld {

   public static void main(String[] args) {
      System.out.println("Hello World!");
   }
}

Sortie 

Hello World!

Balise Java