📝 Ce que vous apprendrez

• Pourquoi les commentaires sont-ils utiles ?
• Commentaires sur une ou plusieurs lignes
• Commentaires Javadoc pour la documentation

❓ Qu'est-ce qu'un commentaire ?

Un commentaire est une ligne de votre code qui est ignorée par le compilateur. Il est destiné aux humains, pas aux machines.

Utilisez les commentaires pour expliquer pourquoi vous faites quelque chose, pas quoi - votre code devrait déjà dire quoi.

🧵 Commentaires sur une seule ligne

Utilisez // pour ajouter un commentaire qui se termine au saut de ligne.

// This is a single-line comment
int x = 10; // This sets x to 10

📜 Commentaires sur plusieurs lignes

Utilisez /* */ pour écrire des commentaires sur plusieurs lignes.

/*
This is a multi-line comment.
Useful for longer explanations.
*/
int y = 20;

📚 Javadoc Comments

Utilisez /** */ pour les commentaires Javadoc - ceux-ci sont utilisés pour générer de la documentation externe pour vos classes et méthodes.

/**
 * This method adds two numbers.
 * @param a First number
 * @param b Second number
 * @return Sum of a and b
 */
public int add(int a, int b) {
    return a + b;
}

Générer des documents en utilisant :

javadoc MyClass.java

❌ Commenting Out Code

Vous pouvez désactiver temporairement un code sans le supprimer :

// int temp = 42;
// System.out.println(temp);

Idéal pour le débogage ou les tests.

📘 Recap

• Utilisez // pour les lignes simples, /* */ pour les blocs.
• Utiliser /** */ pour générer de la documentation (Javadoc)
• Commentez pourquoi quelque chose est fait, et pas seulement quoi.
• Éviter de sur-commenter un code évident