Commentaires Java : Types, utilisation et bonnes pratiques

Commentaires Java

Ce guide explique les commentaires Java, pourquoi ils sont importants et comment les utiliser correctement pour un code plus clair et plus maintenable.

En programmation, les commentaires sont des sections de code source que les compilateurs Java ignorent. Ils aident les développeurs à comprendre l'intention du code sans affecter l'exécution. Par exemple :

// déclarer et initialiser deux variables
int a = 1;
int b = 3;
// afficher la sortie
System.out.println("This is output");

Ici, nous avons utilisé deux commentaires : déclarer et initialiser deux variables et afficher la sortie.

---

Types de commentaires en Java

Java prend en charge deux styles de commentaires principaux :

• Commentaire sur une seule ligne
• Commentaire sur plusieurs lignes

---

Commentaire sur une seule ligne

Un commentaire sur une seule ligne commence par // et s'étend jusqu'à la fin de la ligne. Exemple :

// Exemple de programme "Hello, World!"
class Main {
    public static void main(String[] args) {
        // affiche "Hello, World!"
        System.out.println("Hello, World!");
    }
}

Sortie :

Hello, World!

Nous avons utilisé deux commentaires sur une seule ligne : "Hello, World!" programme exemple et affiche "Hello, World!". Le compilateur ignore tout ce qui va de // à la fin de la ligne.

---

Commentaire sur plusieurs lignes

Quand vous avez besoin de plusieurs lignes, utilisez /* … */. Exemple :

/* Ceci est un exemple de commentaire sur plusieurs lignes.
 * Le programme affiche "Hello, World!" sur la sortie standard.
 */
class HelloWorld {
    public static void main(String[] args) {
        System.out.println("Hello, World!");
    }
}

Sortie :

Hello, World!

Le compilateur saute tout ce qui se trouve entre /* et */. C'est aussi appelé un commentaire traditionnel.

---

Utiliser les commentaires efficacement

Les commentaires ne doivent pas remplacer un code clair. Écrivez d'abord un code bien structuré et auto-documenté, puis ajoutez des commentaires pour expliquer le « pourquoi » derrière les décisions — algorithmes complexes, choix de conception, ou logique non évidente.

Bien que certains préconisent un minimum de commentaires, une explication concise peut grandement améliorer la lisibilité pour les futurs mainteneurs.

Note : Préférez les commentaires qui expliquent pourquoi un morceau de code existe plutôt que comment il fonctionne.