Retour au cours

Commentaires et lisibilité du code : meilleures pratiques

JavaScript : Le cours complet pour débutant, de « Zéro à Héros »

5. Commentaires et lisibilité

Le code est lu beaucoup plus souvent qu'il n'est écrit. Les commentaires aident à expliquer pourquoi le code fait ce qu'il fait.

1. Commentaires sur une seule ligne

Utilisez deux barres obliques (//).

javascript // Cette ligne déclare une variable pour stocker le nom de l'utilisateur let userName = 'Alice';

let age = 30; // Les commentaires en ligne peuvent expliquer des parties complexes

2. Commentaires multi-lignes

Utilisés pour des explications plus longues ou pour désactiver temporairement de gros blocs de code. Commencez par /* et terminez par */.

javascript /* Cette fonction calcule le prix total, incluant les taxes et les frais de port. Elle nécessite trois paramètres : le prix de base, le taux de taxe, et un drapeau booléen pour la livraison premium. */ function calculateTotal(price, tax, premium) { // ... logique de la fonction }

Bonnes pratiques pour la lisibilité

  1. Noms significatifs : Les variables et les fonctions doivent indiquer clairement leur rôle (ex: utilisez firstName au lieu de fn).
  2. Formatage cohérent : Utilisez l'indentation (généralement 2 ou 4 espaces) de manière constante.
  3. Évitez les commentaires excessifs : Si le code est clair, le commentaire est redondant.