Commentaires en Java

1. Deux types de commentaires

Nous devrions ajouter quelques mots à ce qui a été dit ci-dessus.

En Java, vous pouvez écrire des commandes, mais vous pouvez également ajouter des commentaires à ces commandes directement dans le code. Le compilateur ignore complètement les commentaires. Lorsque le programme est exécuté, tous les commentaires sont omis.

Voici un exemple :

public class Home
{
   public static void main (String[] args)
   {
      /*
      Now we'll display the phrase 'Amigo is the Best'
      */
      System.out.print("Amigo ");
      System.out.print("is the ");
      System.out.print("Best");
   }
}

Nous avons ajouté le commentaire "Maintenant, nous allons afficher la phrase…". Le début du commentaire est indiqué par une paire de symboles ( /*), et la fin – par ( */). Lorsque le programme est compilé, le compilateur omet tout ce qui se trouve entre les symboles /*et*/

Vous pouvez écrire ce que vous voulez dans un commentaire.

Habituellement, les commentaires dans le code concernent des parties du code difficiles à comprendre. Certains commentaires consistent en des dizaines de chaînes : celles-ci sont souvent écrites avant les méthodes pour décrire les nuances de leur fonctionnement.

Il existe une autre façon d'ajouter un commentaire au code. Vous pouvez utiliser deux barres obliques ( //).

public class Home
{
   public static void main (String[] args)
   {
      System.out.print("Amigo ");
      System.out.print("is the "); // This is also a comment
      System.out.print("Best");
   }
}

Ici, le code commençant par le //et jusqu'à la fin de la ligne par le //est considéré comme un commentaire. En d'autres termes, il n'y a pas de deuxième paire de symboles utilisés pour « compléter le commentaire ».

2. Commentaires de la vie des programmeurs

Au fait, certains commentaires sont vraiment intéressants.

// I'm not responsible for this code. I was forced to write it against my will.

// Dear, future me. Please forgive me for this code.

// If I see something like this once more, I'll have a complete mental breakdown at work.

// If this condition is ever satisfied, please inform me for a reward. Phone: xxx-xxx-xxx.

//
// Dear programmer:
//
// When you finish 'optimizing' this subroutine
// and realize what a huge mistake it was,
// please increment the following counter as a warning
// to the next guy:
//
// total_hours_wasted_here = 42
//

// When I wrote this, only God and I understood what I was doing
// Now only God knows.

// Sometimes it seems that the compiler is just ignoring all my comments

// I dedicate all my code and my work to my wife Darlene,
// who will have to provide for me, our three kids, and the dog when
// it gets released to the public.

// Magic. Don't touch.

Oui, certains commentaires sont très drôles.