Comment écrivez-vous un commentaire javadoc?
Syntaxe
Tout d'abord, nous devons voir la syntaxe de base des commentaires Javadoc en Java. Nous avons donc utilisé l'éditeur simple pour y mettre des commentaires Javadoc et l'affichage de la présentation ci-dessous dans l'image jointe. Le commentaire automatique du document Java commence par un caractère spécial comme un astérisque, et la première ligne du commentaire pourrait être de couleur verte. Vous pouvez voir la représentation d'un commentaire de document Java qui a de nombreux personnages d'astérisque au début de chaque commentaire du début à la fin.
Au début, le commentaire de Java Doc commence par le personnage «/» suivi de deux personnages d'astérisque. En même temps, toutes les autres lignes contiennent un seul personnage astérisque à leur début. À la fin d'un commentaire de document Java, nous l'avons terminé avec le personnage «/». Entre cette illustration de commentaires de document Java, vous verrez une ligne de commentaire «7» où nous avons défini le nom d'un auteur utilisant le caractère «@» pour définir une variable «auteur» avec le nom d'un auteur de commentaires, je.e., Saeed Raza. Les informations sur les métadonnées des commentaires du document Java doivent toujours être écrites avec le personnage «@».
Créer un commentaire automatique Java Doc dans Eclipse IDE
Cet exemple utilise l'environnement de développement Java Eclipse IDE pour créer des commentaires automatiques dans le projet Java. Pour cela, vous devez avoir un IDE Eclipse monté et configuré à votre fin. Alors, lancez l'Eclipse IDE et essayez de créer un nouveau projet nommé «Java». Il vous demandera de nommer le package de projet actuel. Nous l'avons également nommé «java». Après cela, vous devez créer un nouveau fichier Java ou créer une nouvelle classe dans le même projet Java. Pour cela, le coup droit sur le nom du package du coin gauche de la barre d'explorateur du projet Eclipse IDE, passez à l'option «nouvelle» et appuyez sur le mot-clé «classe» à partir des options élargies. Cela générera une nouvelle fenêtre sur votre écran avec le titre «New Java Class», comme affiché dans l'image ci-dessous.
Maintenant, vous devez insérer le nom d'une classe à créer dans la zone de texte devant l'étiquette «Nom». La plupart des choses seront laissées inchangées car elles ont été sélectionnées automatiquement chaque fois que vous essayez de créer une nouvelle classe. Vous avez juste besoin d'effacer la fin de la méthode que vous souhaitez créer pour votre code Java. Par conséquent, nous avons coché la première case à cocher pour créer une fonction de pilote Main () dans cette classe. Enfin et surtout, vous trouverez une opportunité d'ajouter les commentaires par défaut dans le programme Java à créer. Il vous suffit de vérifier la case nommée "Générer des commentaires". Ce sera une étape phénoménale dans la création du code Java. Appuyons sur le bouton «Finition» après avoir fourni toutes les informations nécessaires.
Le programme Java à croisement montré a été créé dans l'outil Eclipse IDE ainsi que des commentaires automatiques. Vous pouvez voir que les commentaires de Java Doc ont commencé avec les personnages d'astérisque. Il fournit également des informations sur les métadonnées concernant le projet, je.e., l'auteur. Parallèlement à cela, il montre également que le commentaire automatique représente que nous avons également créé une fonction principale de talon. Il s'agit de la génération automatique de commentaires Javadoc dans Eclipse IDE.
Exemple 01: Commentaires Javadoc
Maintenant, vous pouvez créer vos propres commentaires de documents Java lors du codage. Voici une autre illustration pour le faire. Chaque fois que vous utilisez la fonction du pilote principal () dans le code, je.e., Vous auriez dû l'utiliser dans chaque programme, vous devriez toujours créer son commentaire en haut du fichier ou, dans cette fonction, démarrer comme «// Toda généré par la méthode générée». Ce commentaire explique que la méthode principale () a été générée automatiquement, je.e., Tu n'as pas besoin de l'écrire.
Après cela, nous avons ajouté un long commentaire javadoc en expliquant l'utilisation de ce programme avec ses informations de méta-données, je.e., auteur, version et la date à laquelle il a été créé. Avant la déclaration «println», une seule ligne de commentaires est utilisée pour expliquer le but de l'utilisation de la fonction println (). C'est tout pour cet exemple.
L'exécution des programmes avec des commentaires n'affecte pas la sortie comme ci-dessous.
Exemple 01: commentaires en une seule ligne et multiligne
Après avoir parcouru les commentaires de Javadoc dans Eclipse IDE, commençons à jeter un œil à un autre exemple de Java en utilisant les commentaires à une seule ligne et multi-lignes, je.e., défini par l'utilisateur. Nous avons maintenant généré un nouveau «test» de classe et inclus la méthode principale (). Cette méthode contient une instruction de fonction println () pour afficher quelque chose. Nous avons utilisé un commentaire en une seule ligne avec le nom d'une classe commençant par des caractères «//», je.e., explique que c'est l'initialisation de classe. Sur la ligne de définition de la fonction Main () a ajouté un commentaire multi-lignes à partir des caractères "/ *" et se terminant par des caractères "* /".
Conclusion
Cet article vous aide à comprendre l'importance et la vitalité des commentaires utilisés dans la vie quotidienne et la programmation de la vie. Il explique comment ces commentaires peuvent vous aider de plusieurs manières. Premièrement, nous avons discuté des commentaires Javadoc et expliqué très brièvement leur syntaxe. Après cela, nous avons expliqué toute la méthode dans Eclipse IDE pour générer les commentaires Javadoc automatiques en quelques secondes et en quelques clics sur l'interface graphique.