Comment écrire du code propre

Pourquoi écrire du code propre ? ⛩️

Imaginez que si vous essayiez de trouver quelque chose dans une pièce en désordre, vous perdriez du temps à chercher, n'est-ce pas ?

Il en va de même pour le code désordonné ! Il est PLUS DIFFICILE de trouver des problèmes ou de comprendre ce qui se passe. Avec un code propre, vous pouvez éviter ce gâchis.

Vous savez quoi ?.. En écrivant du code propre, vous ferez également gagner un temps précieux aux autres développeurs. Croyez-moi... Vous sauvez le monde ! ?

---

7 conseils pour écrire du code propre ?

1. Utilisez des noms significatifs

Lorsque vous créez une variable ou une fonction, donnez-lui un nom qui indique ce qu'elle fait.

Pensez-y comme si vous nommiez un dossier sur votre ordinateur. Au lieu de l’appeler b, appelez-le numberOfUsers. De cette façon, vous n'avez pas besoin de commentaires supplémentaires pour expliquer ce qu'est b.

Exemple :

let numberOfUsers = 5; // Clear and easy to understand

2. Suivez le principe de responsabilité unique (SRP)

Une fonction doit faire un travail et bien le faire.

Cela facilite la compréhension et la correction si nécessaire. C'est comme avoir un outil pour une tâche, comme un crayon pour écrire et des ciseaux pour couper.

Exemple :

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

Cette fonction n'ajoute que deux nombres. Cela ne fait rien d’autre.

3. Évitez les commentaires inutiles

Au lieu d'ajouter des commentaires partout, essayez de rendre votre code explicite en utilisant des bons noms.

Utilisez les commentaires uniquement lorsque quelque chose est difficile ou nécessite une note spéciale. Trop de commentaires peuvent dérouter les gens. ??

Exemple :

// Good: Clear name, no extra comment needed
let userAge = 25; 

// Bad: Unclear name, needs a comment
let a; // age of the user

4. Rendez votre code lisible

Utilisez des espaces, des indentations et des sauts de ligne pour garder votre code propre.

Tout comme pour écrire un paragraphe, vous devez diviser votre code en morceaux plus petits afin qu'il ne soit pas entièrement sur une seule ligne.

Exemple :

// Good Code
if (isLoggedIn) {
    console.log("Welcome!");
} else {
    console.log("Please log in.");
}

// Bad Code
if(isLoggedIn){console.log("Welcome!");}else{console.log("Please log in.");}

5. Écrire des tests unitaires

Les tests unitaires sont des contrôles de votre code.

Ils s'assurent que tout fonctionne comme il se doit. Lorsque vous modifiez votre code, ces tests vous diront si quelque chose se casse.

Exemple :

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

// Test
console.assert(add(2, 3) === 5, 'Test failed: 2 + 3 should be 5');

6. Soyez prudent avec les dépendances

Lorsque vous créez un logiciel, essayez de garder les choses séparées afin qu'elles ne dépendent pas trop les unes des autres.

Par exemple, un lave-vaisselle peut être installé dans n'importe quelle cuisine, pas seulement dans une cuisine spécifique. C'est plus facile à gérer de cette façon.

7. Organisez votre projet

Gardez vos fichiers et dossiers organisés, tout comme garder votre bureau propre. Cela facilite la recherche d'éléments lorsque votre projet prend de l'ampleur.

Exemple :

• Utilisez des dossiers tels que des composants, des services et des utilitaires dans votre projet.
• Gardez les fichiers similaires ensemble pour savoir où les chercher.

✅ Recommandation

Utilisez ce modèle de notion de développeur backend imprimable pour suivre vos progrès ! ?

Les développeurs débutants ont souvent du mal à choisir la bonne pile technologique, ce qui les amène à perdre du temps et à perdre leur motivation.

Ainsi, j'ai créé une feuille de route de développement backend de 6 mois au design magnifique et très facile à suivre dans Notion afin que vous puissiez suivre vos progrès et respecter facilement vos objectifs !

Cette feuille de route :

• ?️ Fournit un chemin clair pour éviter toute confusion.
• ? Vous aide à rester motivé en indiquant par où commencer et par où terminer.
• ? Suit un plan structuré, semblable à un programme scolaire.
• ? Organise votre apprentissage avec des objectifs hebdomadaires pour les outils et les langues.
• ⏳ Assure un achèvement en 6 mois, couvrant tout ce dont vous avez besoin.
• ? Présente un beau design pour une navigation facile.

---

Conclusion ?

Écrire du code propre, c'est comme construire une base solide pour une maison. Il garde tout en ordre, ce qui facilite l'ajout de nouvelles choses ou la résolution de problèmes sans trop de problèmes.

Suivez ces 7 conseils pour rendre votre code simple, lisible et facile à utiliser !

Lire la suite : compétences pour devenir développeur backend en 6 mois (feuille de route)

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!