Dans ce didacticiel, vous découvrirez les commentaires Java, pourquoi nous les utilisons et comment les utiliser correctement.
En programmation informatique, les commentaires sont une partie du programme complètement ignorée par les compilateurs Java. Ils sont principalement utilisés pour aider les programmeurs à comprendre le code. Par exemple,
// declare and initialize two variables int a =1; int b = 3; // print the output System.out.println("This is output");
Ici, nous avons utilisé les commentaires suivants,
- déclarer et initialiser deux variables
- imprimer la sortie
Types de commentaires en Java
En Java, il existe deux types de commentaires:
- commentaire sur une seule ligne
- commentaire multiligne
Commentaire sur une seule ligne
Un commentaire sur une seule ligne commence et se termine sur la même ligne. Pour écrire un commentaire sur une seule ligne, nous pouvons utiliser le //
symbole. Par exemple,
// "Hello, World!" program example class Main ( public static void main(String() args) ( ( // prints "Hello, World!" System.out.println("Hello, World!"); ) )
Sortie :
Bonjour le monde!
Ici, nous avons utilisé deux commentaires sur une seule ligne:
- "Bonjour le monde!" exemple de programme
- imprime "Hello World!"
Le compilateur Java ignore tout de //
la fin de la ligne. Par conséquent, il est également connu sous le nom de commentaire de fin de ligne .
Commentaire multiligne
Lorsque nous voulons écrire des commentaires sur plusieurs lignes, nous pouvons utiliser le commentaire sur plusieurs lignes. Pour écrire des commentaires sur plusieurs lignes, nous pouvons utiliser le symbole / *…. * /. Par exemple,
/* This is an example of multi-line comment. * The program prints "Hello, World!" to the standard output. */ class HelloWorld ( public static void main(String() args) ( ( System.out.println("Hello, World!"); ) )
Sortie :
Bonjour le monde!
Ici, nous avons utilisé le commentaire multiligne:
/* This is an example of multi-line comment. * The program prints "Hello, World!" to the standard output. */
Ce type de commentaire est également appelé commentaire traditionnel . Dans ce type de commentaire, le compilateur Java ignore tout de /*
à */
.
Utilisez les commentaires de la bonne manière
Une chose que vous devez toujours considérer est que les commentaires ne devraient pas remplacer un moyen d'expliquer un code mal écrit en anglais. Vous devez toujours écrire un code bien structuré et auto-explicatif. Et puis utilisez des commentaires.
Certains pensent que le code devrait être auto-descriptif et que les commentaires devraient être rarement utilisés. Cependant, à mon avis personnel, il n'y a rien de mal à utiliser des commentaires. Nous pouvons utiliser des commentaires pour expliquer des algorithmes complexes, des expressions régulières ou des scénarios où nous devons choisir une technique parmi différentes techniques pour résoudre des problèmes.
Remarque : dans la plupart des cas, utilisez toujours des commentaires pour expliquer « pourquoi » plutôt que « comment » et vous êtes prêt à partir.