Comprendre le code propre : le formatage ⚡️

Dans le développement de logiciels, le code n'est pas seulement destiné aux machines mais aussi aux humains.

Un formatage approprié du code est crucial pour la lisibilité et la maintenabilité.

Le chapitre 5 de Clean Code aborde ces principes, en se concentrant sur l'importance du formatage pour le code professionnel.

---

? Pourquoi le formatage est important

Un formatage approprié n'est pas seulement une question d'esthétique ; c'est une question de clarté. Code bien formaté :

• Améliore la lisibilité : D'autres développeurs (ou votre futur moi) peuvent rapidement comprendre ce que fait le code.

• Améliore la maintenabilité : Un code proprement formaté est plus facile à mettre à jour, à refactoriser et à déboguer.

• Favorise la cohérence : Un code cohérent est prévisible, réduisant ainsi la charge cognitive de quiconque le lit.

---

? Principes clés du formatage du code

? 1. Ouverture verticale : regrouper le code associé

L'ouverture verticale fait référence à l'utilisation de lignes vides pour séparer des blocs de code distincts, ce qui facilite la distinction des différentes sections.

Exemple :

function processOrder(order) {
    // Validate the order
    if (!validateOrder(order)) {
        throw new Error("Invalid order");
    }

    // Process payment
    const paymentResult = processPayment(order);

    // Update inventory
    updateInventory(order);

    // Notify customer
    notifyCustomer(order);
}

Dans cet exemple, chaque étape de la fonction processOrder est séparée par une ligne vierge, délimitant clairement les différentes phases du processus.

---

? 2. Ouverture horizontale : aligner le code pour plus de clarté

L'ouverture horizontale consiste à aligner le code horizontalement pour le rendre plus lisible, en particulier lorsqu'il s'agit d'instructions similaires ou liées.

Exemple :

const productName  = "Laptop";
const productPrice = 999.99;
const productStock = 50;

Aligner les déclarations de variables de cette manière permet de voir plus facilement ce que chaque variable représente en un coup d'œil.

---

? 3. Indentation : structurer le code de manière hiérarchique

L'indentation est essentielle pour refléter la structure hiérarchique du code. Il aide les lecteurs à identifier rapidement les blocs de code qui vont ensemble, tels que les boucles, les conditions et les fonctions.

Exemple :

function calculateDiscount(price) {
    if (price > 100) {
        return price * 0.1;
    } else {
        return 0;
    }
}

Ici, la structure if-else est en retrait pour indiquer que les instructions return font partie de la logique conditionnelle.

---

? 4. Longueur de ligne : la garder gérable

Les longues lignes de code peuvent être difficiles à lire et à comprendre. La règle générale est de limiter les lignes à 80-100 caractères. Si une ligne est trop longue, pensez à la diviser.

Exemple :

// Instead of this:
const orderSummary = `Order for ${customer.name}, Total: $${order.total}, Items: ${order.items.length}`;

// Do this:
const orderSummary = `Order for ${customer.name}, 
    Total: $${order.total}, 
    Items: ${order.items.length}`;

Répartir la chaîne sur plusieurs lignes la rend plus lisible, surtout si la chaîne contient plusieurs variables.

---

? 5. Renforcement cohérent : réduire l'encombrement

Le style de barrage est un autre domaine où la cohérence est cruciale. Les deux styles courants sont :

• Style K&R : Accolade ouvrante sur la même ligne que la déclaration.
• Style Allman : Accolade d'ouverture sur une nouvelle ligne.

Exemple de style K&R :

function add(a, b) {
    return a + b;
}

Exemple de style Allman :

function add(a, b) 
{
    return a + b;
}

Choisissez un style et respectez-le dans toute votre base de code. La cohérence est plus importante que le style spécifique.

---

? 6. Évitez le code dense : laissez de la place pour respirer

Le code dense, où trop d'opérations sont entassées dans un petit espace, peut être difficile à lire. Étalez votre code pour le rendre plus accessible.

Exemple :

// Dense code
if (user.isLoggedIn) { user.showDashboard(); }

// Better
if (user.isLoggedIn) {
    user.showDashboard();
}

La deuxième version est plus lisible car l'appel de fonction se fait sur une ligne distincte de la condition.

---

---

Conclusion ✅

Le formatage est important pour la lisibilité et la maintenabilité du code.

En suivant les principes de Clean Code, vous pouvez rendre votre code JavaScript plus professionnel et plus facile à comprendre et à utiliser.

Bon codage !

Ce qui précède est le contenu détaillé de. pour plus d'informations, suivez d'autres articles connexes sur le site Web de PHP en chinois!