Comment écrire du code propre – Conseils pour les développeurs avec exemples

Imaginez une pièce si en désordre que vous ne trouvez pas vos clés. Des vêtements partout, des livres entassés et le chaos règne en maître.

Imaginez maintenant travailler dans un code désordonné.

C'est le MÊME désastre, sauf maintenant c'est ton cerveau qui PERD la raison.


Un code propre, en revanche, c'est comme entrer dans une pièce impeccable. Tout est exactement là où il devrait être. Pas de stress. Aucune confusion. Juste de la clarté.

Voici la vérité : écrire du code propre n'est PAS facultatif si vous voulez réussir dans le développement de logiciels.

Vous pouvez écrire du code désordonné et être la personne qui a du mal à corriger chaque bug, ou vous pouvez maîtriser un code propre et DOMINER chaque projet que vous touchez.

---

Codeur propre contre codeur désordonné

Laissez-moi vous dresser un tableau.

Voici un graphique qui montre le parcours de deux types de codeurs :

• ⚠️ Bad Coder (Ligne rouge) : Démarre vite mais plante durement. Plus ils écrivent de lignes, plus ils créent des problèmes.
• ⚡ Clean Code (ligne bleue) : Démarre lentement mais reste cohérent. La croissance ne s’arrête pas,elle s’accélère.

Maintenant, vous décidez quelle ligne vous souhaitez suivre.

Coût du mauvais code

Pour illustrer ce graphique, dans la phase de développement initiale, un mauvais code est légèrement plus coûteux à modifier qu'un code propre.

Cependant, à mesure que nous passons aux phases de maintenance et de refactoring, l'écart se creuse SIGNIFICATIVEMENT, le mauvais code coûtant près de DEUX FOIS plus cher qu'un code propre.

Au cours de la phase d'héritage, le mauvais code atteint 100 % du coût, il est désormais EXTRÊMEMENT coûteux à mettre à jour, tandis que le code propre reste plus gérable à 45 %.

Il ne fait aucun doute qu'un mauvais code est un problème COÛTEUX dans le développement de logiciels.

---

10 règles à toute épreuve pour écrire du code propre

1. Utilisez des noms qui signifient quelque chose

Nommer vos variables ou fonctions b ou x est un crime. Appelez-les comme ils sont.

// Weak and vague
let b = 5;

// Strong and clear
let numberOfUsers = 5;

Les gens qui écrivent des noms peu clairs ne veulent pas reconnaître leurs erreurs. Ne soyez pas cette personne.

---

2. Gardez les fonctions centrées sur le laser (SRP)

Une fonction doit faire une chose et la faire parfaitement. C'est ce qu'on appelle le principe de responsabilité unique (SRP).

Un bon code est comme un marteau. Il touche UN clou, pas dix.

// Clean: One job, one focus
function calculateTotal(a, b) {
    return a + b;
}

function logTotal(user, total) {
    console.log(`User: ${user}, Total: ${total}`);
}

// Dirty: Trying to do EVERYTHING
function calculateAndLogTotal(a, b, user) {
    let total = a + b;
    console.log(`User: ${user}, Total: ${total}`);
}

Lorsque vous mélangez tâches, vous mélangez CONFUSION avec le désastre.

---

3. Arrêtez d'utiliser les commentaires comme béquille

Vous n'expliquez pas ce que fait une porte CHAQUE fois que quelqu'un entre dans une pièce. Votre code devrait fonctionner de la même manière.

// Clean: Self-explanatory
let userAge = 25;

// Messy: Needs an explanation
let a; // This means "age of the user"

Les commentaires ne sont pas mauvais, mais si votre code ne peut pas tenir debout tout seul, vous avez déjà échoué.

---

4. Rendre le lisible

Si quelqu'un qui lit votre code a l'impression qu'il résout une énigme, vous êtes DÉJÀ devenu un fauteur de troubles.

// Clean: Reads like a story
if (isLoggedIn) {
    console.log("Welcome!");
} else {
    console.log("Please log in.");
}

// Messy: Feels like chaos
if(isLoggedIn){console.log("Welcome!");}else{console.log("Please log in.");}

Le code lisible n'est pas réservé aux autres :c'est pour vous dans six mois.

---

5. Testez tout ce que vous écrivez

Si vous êtes trop paresseux pour écrire des tests, NE vous plaignez PAS lorsque votre code tombe en panne.

class Calculator {
    add(a, b) { return a + b; }
    subtract(a, b) { return a - b; }
}

// Test it (Unit Test)
const calculator = new Calculator();
console.assert(calculator.add(2, 3) === 5, "Addition failed");
console.assert(calculator.subtract(5, 3) === 2, "Subtraction failed");

Les tests sont votre police d'assurance. Ignorez-les et vous jouez avec votre temps.

---

6. Attention aux dépendances

Les dépendances sont comme des AFFAIRES. Obtenez les BONS et vous GAGNEZ. Choisissez mal et vous êtes enfermé dans quelque chose que vous regretterez.

// Dependency: Sending emails with Nodemailer
const nodemailer = require('nodemailer');
function sendEmail(to, subject, message) {
    const transporter = nodemailer.createTransport({ /* config */ });
    return transporter.sendMail({ from: "you@example.com", to, subject, text: message });
}

Évitez les dépendances de codage en dur. Utilisez des abstraction ou des fichiers de configuration pour une maintenance sécurisée.

Ceci n'est qu'un exemple. En tant que développeur, vous pouvez utiliser des CENTAINES de bibliothèques ou de dépendances.

Je ne dis pas qu’il ne faut pas compter sur eux, de nos jours il est difficile de les éviter. Mais vous devez être très prudent AVANT de les installer dans vos projets de codage.

Vous devez vérifier la sécurité, les performances, la qualité ou la fonctionnalité des systèmes logiciels d'une organisation. Parce que ils comportent parfois des risques qui peuvent ruiner ENTIER votre projet.

CONTRÔLEZ toujours vos outils, ne les laissez pas VOUS contrôler.

---

7. Organisez un projet comme un patron

Un projet bien organisé fait la différence entre un vide-grenier et un haut de gamme boutique.

myProject
├── src
│   ├── components
│   ├── services
│   ├── utils
└── tests

Voici comment CHAQUE dossier doit être organisé pour ce projet :

Si votre base de code ressemble à un tiroir à déchets, vous avez déjà perdu le respect de votre futur moi.

Structure de projet solide d'une application de messagerie :
Disons que vous créez une application qui envoie des e-mails aux utilisateurs. La structure de votre projet SOLID infrangible de type patron devrait ressembler à ceci :

---

8. Soyez cohérent avec le formatage

Ne codez pas comme une personne avec 10 personnalités. Soyez cohérent avec votre formatage.

Utilisez des outils comme Prettier ou ESLint pour appliquer votre style COHÉRENT. Si chaque fichier est différent, vous créez un chaos que PERSONNE ne veut réparer.

Je dirais que la cohérence du formatage est un principe fondamental d'un code propre car elle garantit la lisibilité.

Jetez un oeil...

Utilisez 2 ou 4 espaces pour l'indentation de manière cohérente dans toute votre base de code. Évitez les onglets pour maintenir l'uniformité entre les différents éditeurs.

Conservez les lignes à un maximum de 100 à 120 caractères pour empêcher le défilement horizontal et améliorer la lisibilité.

Regrouper la logique associée ensemble et séparer les blocs de code avec des lignes vierges pour mettre en évidence leur objectif.

Enfin, évitez de trop aligner le code ; au lieu de cela, laissez l'indentation guider naturellement le flux de la logique.

---

9. Arrêtez de coder en dur les valeurs

Le codage en dur est une paresse déguisée en effort. Jetez un oeil :

// Weak and vague
let b = 5;

// Strong and clear
let numberOfUsers = 5;

Donc, le codage en dur est le raccourci qui vous fait tomber d'une falaise.

---

10. Gardez les fonctions courtes

Si votre fonction plus de 20 lignes, c'est probablement essayer d'en faire trop. Décomposer.

// Clean: One job, one focus
function calculateTotal(a, b) {
    return a + b;
}

function logTotal(user, total) {
    console.log(`User: ${user}, Total: ${total}`);
}

// Dirty: Trying to do EVERYTHING
function calculateAndLogTotal(a, b, user) {
    let total = a + b;
    console.log(`User: ${user}, Total: ${total}`);
}

Les fonctions courtes sont des fonctions pointues. Ils ont atteint leur cible à CHAQUE fois.

---

??Cadeau de Noël !

TOUT LE MONDE peut écrire du code compliqué. Même l’IA peut produire des déchets.

Mais écrire du code propre ? C'est la compétence qui sépare les amateurs des programmeurs professionnels.

Vous souhaitez dominer le développement logiciel ? Écrivez du code propre. Aussi simple que ça.

Comment écrire du code propre alors ?

Laissez-moi vous dire quelque chose : ce que vous venez de lire dans cet article n'est RIEN de plus qu'une gouttelette de l'océan de connaissances contenue dans mon livre, Clean Code Zero to One.

Ces 10 règles ? Ils sont juste la SURFACE.

Le livre approfondit CHAQUE principe, CHAQUE règle et CHAQUE technique, expliqués de manière si claire et détaillée que vous ne les oublierez JAMAIS.

Je l'ai rempli de des milliers d'illustrations numériques et de scénarios du monde réel qui ne se contentent pas de vous apprendre, ils vous entraînent dans le monde du codage propre comme rien de ce que vous pourriez faire. que j'ai déjà vu.

La vérité est que les codeurs désordonnés ne SURVIVEnt. Ils se noient dans leur propre chaos. Les codeurs propres DOMINENT. Ils écrivent des logiciels qui résistent à l’épreuve du temps et ne luttent JAMAIS contre des bogues qu’ils ne peuvent pas corriger ou des fonctionnalités qu’ils NE PEUVENT PAS ajouter.

Si vous êtes SÉRIEUX à l'idée de manifester la MANIÈRE dont vous écrivez du code, ce livre n'est pas une option, c'est un incontournable.

Et parce que c’est Noël, je vous facilite la tâche. Utilisez le code promo MERRYCHRISTMAS pour obtenir 50% de réduction.

Mais n'attendez pas trop longtemps, cette offre se termine le 31 décembre 2024.

Cliquez sur le lien ci-dessous pour obtenir ce livre.

? Obtenez le Clean Code Zero to One maintenant

Le choix vous appartient. Vous pouvez continuer à écrire du code désordonné, perdre du temps et de l'énergie, ou vous pouvez PRENDRE LE CONTRÔLE, apprendre à DOMINER vos projets et CONSTRUIRE des logiciels comme un BOSS.

? Suivez-moi pour en savoir plus : @shahancd
? Ma Newsletter Hebdomadaire :Horscoder

---

En savoir plus : écrire des composants propres et réutilisables dans React

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!