Qualité du Code

Bonnes pratiques et améliorations

Pourquoi améliorer la qualité du code?

Un code de qualité est essentiel pour maintenir un projet durable, évolutif et facile à comprendre. Cela réduit les bugs, facilite la collaboration et diminue les coûts de maintenance à long terme.

Citation importante

"Tout codeur peut écrire du code que l'ordinateur peut comprendre. Les bons programmeurs écrivent du code que les humains peuvent comprendre." - Martin Fowler

Code quality illustration

Checklist d'Amélioration

Lisibilité

  • Noms de variables explicites
  • Indentation cohérente
  • Commentaires pertinents

Structure

  • Découpage en petites fonctions
  • Éviter la duplication (DRY)
  • Architecture modulaire

Robustesse

  • Gestion des erreurs
  • Validation des entrées
  • Tests unitaires

Exemples Concrets

À éviter

function p(d) {
  let r=0;
  for(let i=0;i<d.length;i++) {
    r+=d[i].p;
  }
  return r/d.length;
}

Problèmes :

  • Noms de variables obscurs
  • Pas de gestion d'erreur
  • Fonction fait plusieurs choses

À privilégier

/**
 * Calcule la moyenne des prix d'un tableau de produits
 * @param {Array<Product>} products - Tableau d'objets produits
 * @returns {number} La moyenne des prix
 * @throws {Error} Si le tableau est vide ou invalide
 */
function calculateAveragePrice(products) {
  if (!Array.isArray(products) || products.length === 0) {
    throw new Error('Le tableau de produits doit contenir au moins un élément');
  }
  
  const total = products.reduce((sum, product) => {
    return sum + (product.price || 0);
  }, 0);
  
  return total / products.length;
}

Améliorations :

  • Noms explicites
  • Documentation
  • Gestion des erreurs
  • Fonction pure

Outils Utiles

ESLint

Analyse statique pour JavaScript

Prettier

Formateur de code automatique

SonarQube

Analyse de qualité complète