Comment commenter dans Java?

Les commandes sont très importantes dans la programmation informatique. Ce sont des explications simples du code source qui rendent le code source plus compréhensible pour les humains. Cependant, ceux-ci ne sont pas pris en compte par le compilateur ou l'interprète.

Importance des commentaires

Comme discuté ci-dessus, les commentaires sont nécessaires car ils rendent un programme informatique plus compréhensible. Les avantages des commentaires sont répertoriés ci-dessous.

• Rend le code facile à lire.
• Maintenance du code sans effort et détection d'erreurs.
• Fournir des détails sur une certaine méthode, classe, variable ou déclaration.
• Les fonctions écrites pour une utilisation par d'autres deviennent plus faciles à comprendre.

Comme dans d'autres langages de programmation, vous pouvez également écrire des commentaires dans Java. Cet article explore divers types de commentaires Java et comment les utiliser avec leurs exemples.

Types de commentaires Java

En Java, il y a trois approches pour commenter comme indiqué ci-dessous.

Commentaire unique

Afin de commenter une seule ligne, des commentaires à ligne unique sont utilisés qui commencent par deux tronçonnettes. Le texte écrit après ces barres obligées est ignorée par le compilateur Java.

Voici la syntaxe du commentaire en ligne unique Java:

// c'est un commentaire à une seule ligne

Exemple

Commentaire multi-lignes

Lorsque vous souhaitez commenter plusieurs lignes dans votre code source Java, utilisez un commentaire multi-ligne. Il commence par / * et se termine par * /. Le texte écrit entre ceux-ci ne sera pas exécuté par le compilateur Java.

Syntaxe

/ * Ceci est un commentaire multi-lignes * /

Exemple

Commentaire de documentation

Les commentaires de documentation sont généralement utilisés pour créer une API de documentation pour les programmes Java plus grands. Ces API de documentation sont utilisées pour référencer les classes, les méthodes et les arguments utilisés dans le code source. Il commence par / ** et se termine par * /.

Voici la syntaxe du commentaire de type de documentation dans Java.

/ **
*
* Pour représenter les paramètres, nous utilisons diverses balises
* ou méthode ou titre
* Ou nous pouvons utiliser des balises HTML
*
* /

Exemple

Le tableau donné ci-dessous couvre plusieurs types de balises Javadoc.

Nom de tag	Syntaxe	Description
@auteur	@author name-text	Il est utilisé pour écrire le nom de l'auteur d'une classe particulière.
@version	Text de version @version	Il est utilisé pour mentionner le texte de la version.
@param	@ param-paramètre Description du nom	Il est utilisé pour ajouter le nom et la description des paramètres.
@retour	@return Description	Il est utilisé pour trouver facilement les valeurs de retour en faisant une section «retourne».
@Deprecated	@Deprecated Deprécated Text	Il est utilisé pour indiquer une classe ou une méthode obsolète ou déposée et crée un avertissement à chaque fois qu'il est utilisé par quelqu'un.
@depuis	Libération de @Since	Il est utilisé pour spécifier la version de la méthode ou de la classe, etc. en ajoutant la section «depuis».
@throws	@throws description de la classe de classe	Il est utilisé pour lancer une exception.
@exception	@Exception Class-Name Description	Il a une utilisation similaire à la balise @throw.
@voir	référence @see	Il est utilisé pour ajouter une référence à une méthode ou une classe en générant un lien dans la section «voir aussi».
@en série	@Serial Field Description | Inclure | exclure	Il est utilisé pour ajouter des informations pertinentes sur les champs sérialisés.
@Serialfield	@Serial Field-Name Field-Type Field-Description	Il est utilisé pour documenter le composant objectStreamfield.
@SerialData	@SerialData Data-Description	Il est utilisé pour documenter les données écrites par des méthodes telles que writeObject () ou WriteExternal ().
@docroot	@docroot	Il est utilisé pour montrer le chemin du répertoire racine.
@code	@code texte	Il est utilisé pour afficher du texte en polices de code.
@valeur	package @value.Class # Field	Il est utilisé pour afficher la valeur de la constante lorsqu'un commentaire DOC est écrit dans un champ statique.
@inheritdoc	-	Il est utilisé pour hériter d'un commentaire d'une classe héritable.
@lien	package @link.Étiquette des membres de classe #	Il comprend un lien qui a concentré la documentation d'un package, d'une classe ou d'un nom de membre particulier d'une classe qui est référée.
@linkplain	package @linkplain.Étiquette des membres de classe #	Similaire au lien avec la seule différence que l'étiquette du lien s'affiche en texte brut plutôt que du texte de code.

Conclusion

Il y a trois types de commentaires en java. Le premier est un commentaire à une seule ligne qui commence par deux slashs avant '//', le second est un commentaire multi-ligne qui commence par / * et se termine par * /, tandis que le dernier est un commentaire de documentation qui est utilisé pour créer API de documentation pour les grands programmes et applications Java. Tous ces types de commentaires sont expliqués dans ce tutoriel avec les balises Javadoc qui sont utilisées dans les commentaires de documentation.