Commentaires en Java

Les commentaires en Java , comme dans la plupart des autres langages de programmation, sont des caractères ignorés lors de l'exécution du programme. Ainsi, vous pouvez ajouter autant de commentaires au programme que nécessaire sans craindre d'augmenter sa taille. Les commentaires sont utilisés pour décrire les subtilités d’un bloc de code, d’une méthode ou d’une classe particulière. Vous pouvez également les utiliser si vous souhaitez laisser des messages aux programmeurs qui travailleront avec ce code à l'avenir. Ou pour vos propres notes.

Façons de mettre en évidence les commentaires

Java propose deux manières de mettre en évidence les commentaires dans le texte.

Commentaire d'implémentation (commentaire de code)

1. Commenter une ligne

   Il s’agit du type de commentaire le plus couramment utilisé. Pour écrire un tel commentaire, vous devez utiliser deux barres obliques //. Dans ce cas, le commentaire commence immédiatement après les caractères //et se poursuit jusqu'à la fin de la ligne.

   System.out.println("Hello, Java world!");
   // наш комментарий

2. Commenter un bloc de texte

   Si vous avez besoin de commentaires plus longs, vous pouvez commencer chaque ligne par des symboles. Bien qu'il soit plus pratique de limiter les blocs de commentaires aux délimiteurs /*et */.

   /*
    Пример простой программы на Java
   */
   
   public class SampleProgram
   {
    public static void main (String [] args)
    {
    System.out.println("Hello, Java world!");
    }
   }

   Il ne faut pas oublier que les commentaires, séparés par des symboles, /*ne peuvent pas */être imbriqués dans le langage Java. Cela signifie qu'un morceau de code ne peut pas être désactivé simplement en l'entourant de /*et , puisque le code désactivé peut lui-même contenir */des délimiteurs /*et */.

Documenter le commentaire

Pour documenter des méthodes, des variables ou des classes, une méthode spéciale de surbrillance du texte est utilisée. Cela se fait en utilisant /**et */. Dans ce cas, chaque ligne de texte commenté commence par *Si une méthode est documentée, il est d'usage de décrire ses arguments et sa valeur de retour.

/**
* Метод возвращает максимальное meaning
* из трех переданных аргументов
* @param a - первый параметр
* @param b - второй параметр
* @param c - третий параметр
* @return - максимальный из параметров
*/
public int max(int a, int b, int c) {
   return Math.max(Math.max(a, b), c);
}

Que lire d'autre ? Par exemple, ce matériel : Commentaires en Java : tout n'est pas si simple . Ou une conférence de la quête Java Syntax Pro sur les commentaires.