Commentaires multi-lignes Java

Les gens se commentaient les uns sur les autres, qu'ils aiment quelque chose les uns sur les autres ou n'aiment pas quelque chose. Si vous êtes déjà allé sur un site Web où vous voulez apprendre quelque chose, vous devez avoir trouvé la section des commentaires où l'auteur vous demande d'écrire vos commentaires sur l'ensemble du contenu. Dans certains cas, vous fournissez les commentaires et dans certains cas, vous essayez de ne faire aucun commentaire. Juste comme ça, les langages de programmation ont également tendance à utiliser les commentaires dans le même fichier de code. Les programmeurs aiment utiliser ces commentaires pour s'aider eux-mêmes à l'avenir pour comprendre le programme même s'il a été récupéré après une décennie. Cela peut également aider les nouveaux apprenants et si vous transmettez votre code à quelqu'un d'autre, il peut prendre de l'aide. Cet article vous aide à comprendre l'utilisation des commentaires multi-lignes ainsi que les autres types.

Exemple 1: commentaires en une seule ligne

Avant de jeter un œil aux commentaires multi-lignes, nous devons acquérir une expérience pratique avec les bases de l'utilisation des commentaires dans la programmation Java ou toute autre programmation. Les commentaires en une seule ligne commencent toujours par un panneau à double barre oblique «//» dans la programmation Java. Le commentaire à une seule ligne n'a pas de personnages de fin spécifiques comme «/» ou «8». Le commentaire ne dépasse que la fin de la ligne et n'inclut pas la ligne de code suivante suivante.

Par conséquent, nous allons expliquer comment ajouter les commentaires en une seule ligne dans un programme Java pour aider à comprendre le code. Pour cela, nous créons un nouveau fichier Java dans son package «Test». Ce programme commence par l'initialisation de la classe principale ainsi que la déclaration de sa fonction principale (). Il y a un total de trois instructions println () utilisées pour afficher une nouvelle sortie à chaque fois dans la zone de sortie de la console Eclipse IDE.

Avant chaque instruction de fonction println (), nous utilisons un commentaire de ligne unique aux lignes 4, 6 et 8. Tous ces trois commentaires en une seule ligne commencent par les caractères de double slash «//» et n'ont pas de personnages de fin spécifiques, sauf dans le cas du troisième commentaire. Notre troisième commentaire explique l'utilisation de la syntaxe de commentaires «multi-lignes» pour la déclaration d'un commentaire à une seule ligne. Cela signifie que vous pouvez utiliser les caractères «/ *» des commentaires multi-lignes pour déclarer un commentaire en une seule ligne, mais vous ne pouvez pas utiliser le commentaire à une seule ligne pour déclarer un commentaire multi-ligne. Pour créer un commentaire à une seule ligne, nous devons mettre fin au commentaire par «* /» sur la même ligne.

Maintenant, nous exécutons ce code ayant des commentaires en une seule ligne dans la méthode principale () et voyons ce qui se passe. La sortie suivante attachée montre les données de texte qui sont utilisées dans les 3 instructions de fonction println () comme Eclipse IDE, Java et Windows. Cette sortie est sans aucune erreur ni avertissement car nous avons inclus les commentaires très correctement dans le programme.

Exemple 2: commentaires multi-lignes

Après avoir examiné les commentaires en une seule ligne, nous discuterons de la façon d'ajouter les commentaires multi-lignes dans la programmation Java. Pour cela, nous créons un nouveau fichier Java nommé «Main.Java "dans son package" Test ". Le nom d'un package est automatiquement généré à la première ligne de code, vous n'avez donc pas besoin de le supprimer. Sinon, cela pourrait lancer une erreur. Ainsi, nous commençons notre programme avec une nouvelle création de classe,. Si vous utilisez un nom de classe différent du nom du fichier, vous obtiendrez des erreurs sur l'outil Eclipse IDE. Évitez d'utiliser différents noms.

Après cela, il est temps d'ajouter votre fonction principale () pour ce programme. Ainsi, nous ajoutons cette méthode principale () dans la classe Main () nouvellement générée car nous n'utiliserons pas d'autres classes ou fonctions et allons effectuer tout dans la méthode principale (). Juste après la déclaration de la méthode principale, nous commençons le commentaire multi-ligne avec les caractères «/ *» au début de sa première ligne et des caractères «* /» à la fin de ce commentaire à la deuxième ligne.

Ce commentaire multi-ligne ne contient que 2 lignes. Nous ajoutons un texte montrant qu'il s'agit d'un commentaire multi-lignes entre les caractères «/ *» et «* /». Après ce commentaire, nous utilisons l'instruction de fonction println () qui publie certains messages texte à la console Eclipse IDE, «Travailler dans Eclipse IDE». Après cela, nous fermons la fonction principale () avec sa classe, tenant tout ce code. Enregistrez ce code et exécutez-le via l'icône Eclipse «Exécuter».

En appuyant sur l'icône «Run» de l'Eclipse IDE, nous obtenons le texte «Working in Eclipse IDE» qui s'affiche dans la zone de sortie Eclipse. Nous avons trouvé zéro erreurs et aucun avertissement car nous avons ajouté la syntaxe parfaite pour les commentaires multi-lignes ainsi que la syntaxe du code entier.

Exemple 3: Commentaires Javadoc

Après avoir eu suffisamment de connaissances concernant les commentaires à une seule ligne et multi-lignes, assurez-vous d'apprendre les commentaires Javadoc au moins par un exemple. Les commentaires Javadoc sont les commentaires automatiques générés par le JDK d'un environnement que vous avez utilisé et peuvent être ajoutés par un utilisateur lui-même. Pour ajouter vous-même ces commentaires Javadoc, vous devez connaître la syntaxe des commentaires Javadoc. Une chose à retenir sur les commentaires de Javadoc est l'utilisation d'un personnage d'astérisque «*» au début de chaque ligne d'un commentaire Javadoc. Ce code affiche la somme de deux valeurs entières et la même chose est expliquée dans son commentaire. Le commentaire comprend également ses informations sur les métadonnées, je.e. Informations «@author».

La sortie affiche la valeur 10 comme sortie de la somme.

Conclusion

Après la grande explication de ce que sont les commentaires et de la façon dont ils peuvent être utilisés dans la vie quotidienne, dans les blogs et la programmation, nous avons discuté des types de commentaires dans Java. Le but de l'utilisation des commentaires est de rendre la morue plus respectueuse de l'homme et lisible par l'homme, en particulier pour les nouvelles abeilles de la programmation. Bien que le sujet de cet article soit de discuter des commentaires multi-lignes, nous avons lancé l'explication avec les commentaires en une seule ligne afin que chaque apprenant ait une idée de base sur chaque type de commentaire. Après cela, l'élaboration des commentaires multi-lignes est couverte d'un exemple de Java.