TechCodeview

Le Java les commentaires sont les instructions d'un programme qui ne sont pas exécutées par le compilateur et l'interpréteur.

Pourquoi utilisons-nous des commentaires dans un code ?

• Les commentaires sont utilisés pour rendre le programme plus lisible en ajoutant les détails du code.
• Cela facilite la maintenance du code et la recherche facile des erreurs.
• Les commentaires peuvent être utilisés pour fournir des informations ou des explications sur le variable , méthode, classe , ou toute autre déclaration.
• Il peut également être utilisé pour empêcher l’exécution du code du programme lors du test du code alternatif.

Types de commentaires Java

Il existe trois types de commentaires en Java.

1. Commentaire sur une seule ligne
2. Commentaire sur plusieurs lignes
3. Commentaire sur la documentation

1) Commentaire Java sur une seule ligne

Le commentaire sur une seule ligne permet de commenter une seule ligne du code. C’est la manière la plus utilisée et la plus simple de commenter les déclarations.

Les commentaires sur une seule ligne commencent par deux barres obliques (//) . Tout texte placé devant // n'est pas exécuté par Java.

Syntaxe:

 //This is single line comment 

Utilisons un commentaire sur une seule ligne dans un programme Java.

CommentExample1.java

 public class CommentExample1 { public static void main(String[] args) { int i=10; // i is a variable with value 10 System.out.println(i); //printing the variable i } } 

Sortir:

 10 

2) Commentaire Java multiligne

Le commentaire multiligne permet de commenter plusieurs lignes de code. Il peut être utilisé pour expliquer un extrait de code complexe ou pour commenter plusieurs lignes de code à la fois (car il sera difficile d'y utiliser des commentaires sur une seule ligne).

Les commentaires sur plusieurs lignes sont placés entre /* et */. Tout texte compris entre /* et */ n'est pas exécuté par Java.

Syntaxe:

une classe abstraite peut-elle avoir un constructeur

 /* This is multi line comment */ 

Utilisons les commentaires multilignes dans un programme Java.

CommentExample2.java

 public class CommentExample2 { public static void main(String[] args) { /* Let's declare and print variable in java. */ int i=10; System.out.println(i); /* float j = 5.9; float k = 4.4; System.out.println( j + k ); */ } } 

Sortir:

 10 

Remarque : généralement // est utilisé pour les commentaires courts et /* */ est utilisé pour les commentaires plus longs.

3) Commentaire sur la documentation Java

Les commentaires de documentation sont généralement utilisés pour écrire des programmes volumineux pour un projet ou une application logicielle, car ils permettent de créer une API de documentation. Ces API sont nécessaires à titre de référence, c'est-à-dire quelles classes, méthodes, arguments, etc. sont utilisés dans le code.

Pour créer l'API de documentation, nous devons utiliser le outil javadoc . Les commentaires de la documentation sont placés entre /** et */.

Syntaxe:

 /** * *We can use various tags to depict the parameter *or heading or author name *We can also use HTML tags * */ 

balises javadoc

Certaines des balises couramment utilisées dans les commentaires de la documentation :

Utilisons la balise Javadoc dans un programme Java.

Calculer.java

 import java.io.*; /** * <h2> Calculation of numbers </h2> * This program implements an application * to perform operation such as addition of numbers * and print the result * <p> * <b>Note:</b> Comments make the code readable and * easy to understand. * * @author Anurati * @version 16.0 * @since 2021-07-06 */ public class Calculate{ /** * This method calculates the summation of two integers. * @param input1 This is the first parameter to sum() method * @param input2 This is the second parameter to the sum() method. * @return int This returns the addition of input1 and input2 */ public int sum(int input1, int input2){ return input1 + input2; } /** * This is the main method uses of sum() method. * @param args Unused * @see IOException */ public static void main(String[] args) { Calculate obj = new Calculate(); int result = obj.sum(40, 20); System.out.println(&apos;Addition of numbers: &apos; + result); } } </p>

Compilez-le avec l'outil javac :

Créer un document

Créer une API de documentation en javadoc outil:

Maintenant, les fichiers HTML sont créés pour le Calculer classe dans le répertoire courant, c'est-à-dire abcDémo . Ouvrez les fichiers HTML et nous pouvons voir l'explication de la classe Calculate fournie via le commentaire de la documentation.

Les commentaires Java sont-ils exécutables ?

Ans: Comme nous le savons, les commentaires Java ne sont pas exécutés par le compilateur ou l'interpréteur, cependant, avant la transformation lexicale du code dans le compilateur, le contenu du code est codé en ASCII afin de faciliter le traitement.

Test.java

 public class Test{ public static void main(String[] args) { //the below comment will be executed // u000d System.out.println('Java comment is executed!!'); } } 

Sortir:

Le code ci-dessus génère la sortie car le compilateur analyse le caractère Unicode u000d comme un nouvelle ligne avant la transformation lexicale, et ainsi le code est transformé comme indiqué ci-dessous :

Test.java

 public class Test{ public static void main(String[] args) { //the below comment will be executed // System.out.println('Java comment is executed!!'); } } 

Ainsi, le caractère Unicode déplace l'instruction d'impression vers la ligne suivante et elle est exécutée comme un code Java normal.