Résumé du code propre

Le code est propre s'il peut être compris facilement – ​​par tous les membres de l'équipe. Le code propre peut être lu et amélioré par un développeur autre que son auteur d'origine. La compréhensibilité implique la lisibilité, la variabilité, l'extensibilité et la maintenabilité.
Règles générales

• Suivez les conventions standard.
• Restez simple, stupide. Plus simple est toujours mieux. Réduisez autant que possible la complexité.
• Règle des boy-scouts. Laissez le terrain de camping plus propre que vous ne l'avez trouvé.
• Trouvez toujours la cause première. Recherchez toujours la cause profonde d'un problème.

Règles de conception

1. Conservez les données configurables à des niveaux élevés.
2. Préférez le polymorphisme à if/else ou switch/case.
3. Code multithread séparé.
4. Empêcher la surconfiguration.
5. Utilisez l'injection de dépendances.
6. Suivez la loi de Déméter. Une classe ne doit connaître que ses dépendances directes.

Conseils de compréhension

1. Soyez cohérent. Si vous faites quelque chose d'une certaine manière, faites toutes les choses similaires de la même manière.
2. Utilisez des variables explicatives.
3. Encapsuler les conditions aux limites. Les conditions aux limites sont difficiles à suivre. Mettez le traitement pour eux au même endroit.
4. Préférez les objets à valeur dédiée au type primitif.
5. Évitez les dépendances logiques. N'écrivez pas de méthodes qui fonctionnent correctement en fonction de quelque chose d'autre dans la même classe.
6. Évitez les conditions négatives.

Règles de noms

1. Choisissez des noms descriptifs et sans ambiguïté.
2. Faites une distinction significative.
3. Utilisez des noms prononçables.
4. Utilisez des noms consultables.
5. Remplacez les nombres magiques par des constantes nommées.
6. Évitez les encodages. N'ajoutez pas de préfixes et ne saisissez pas d'informations.

Règles des fonctions

1. Petit.
2. Faites une chose.
3. Utilisez des noms descriptifs.
4. Préférez moins d'arguments.
5. N'ayez aucun effet secondaire.
6. N'utilisez pas d'arguments de drapeau. Méthode divisée en plusieurs méthodes indépendantes qui peuvent être appelées depuis le client sans l'indicateur.

Règles des commentaires

1. Essayez toujours de vous expliquer en code.
2. Ne soyez pas redondant.
3. N'ajoutez pas de bruit évident.
4. N'utilisez pas de commentaires avec accolade fermante.
5. Ne commentez pas le code. Supprimez simplement.
6. Utiliser comme explication de l'intention.
7. Utiliser comme clarification du code.
8. Utiliser comme avertissement des conséquences.

Structure du code source

1. Séparez les concepts verticalement.
2. Le code associé doit apparaître verticalement dense.
3. Déclarez les variables proches de leur utilisation.
4. Les fonctions dépendantes doivent être proches.
5. Des fonctions similaires devraient être proches.
6. Placez les fonctions vers le bas.
7. Gardez les lignes courtes.
8. N'utilisez pas l'alignement horizontal.
9. Utilisez des espaces blancs pour associer des éléments liés et dissocier des éléments faiblement liés.
10. Ne brisez pas l'indentation.

Objets et structures de données

1. Masquer la structure interne.
2. Préférez les structures de données.
3. Évitez les structures hybrides (moitié objet et moitié données).
4. Devrait être petit.
5. Faites une chose.
6. Petit nombre de variables d'instance.
7. La classe de base ne devrait rien savoir de ses dérivées.
8. Mieux vaut avoir plusieurs fonctions que de passer du code dans une fonction pour sélectionner un comportement.
9. Préférez les méthodes non statiques aux méthodes statiques.

Tests

1. Une assertion par test.
2. Lisible.
3. Rapide.
4. Indépendant.
5. Répétable.

Le code sent

1. Rigidité. Le logiciel est difficile à changer. Un petit changement provoque une cascade de changements ultérieurs.
2. Fragilité. Le logiciel tombe en panne à de nombreux endroits à cause d'un seul changement.
3. Immobilité. Vous ne pouvez pas réutiliser des parties du code dans d'autres projets en raison des risques impliqués et des efforts élevés.
4. Complexité inutile.
5. Répétition inutile.
6. Opacité. Le code est difficile à comprendre.

C'est beaucoup je pense, mais il y a plus.
Lisez le livre complet.

Merci d'avoir lu le résumé, j'espère que cela vous aidera.

Site Internet :
https://kaleemelahi.co

Achetez-moi un café :
https://buymeacoffee.com/kaleemelahi

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!