Le développement de logiciels nécessite de bonnes conceptions de systèmes et de bonnes normes de codage. Le diagramme ci-dessous énumère 10 principes de codage efficaces.¹

• 01 Suivre les spécifications du code
  Lorsque nous écrivons du code, il est important de suivre les normes bien établies de l'industrie, comme "PEP 8", "Google Java Style", l'adhésion à un ensemble de spécifications de code convenues garantit que la qualité du code est cohérente et lisible.
• 02 Documentation et commentaires
  Un bon code doit être clairement documenté et commenté afin d'expliquer la logique et les décisions complexes, et les commentaires doivent expliquer pourquoi une certaine approche a été adoptée ("Pourquoi") plutôt que ce qui est fait exactement ("Quoi"). La documentation et les commentaires doivent être clairs, concis et constamment mis à jour.
• 03 Robustesse
  Un bon code doit être capable de gérer une variété de situations et d'entrées inattendues sans tomber en panne ou produire des résultats imprévisibles. L'approche la plus courante consiste à attraper et à gérer les exceptions.
• 04 Suivre le principe SOLID
  "Responsabilité unique", "ouvert/fermé", "substitution de Liskov", "séparation des interfaces" et "inversion des dépendances" : ces cinq principes (SOLID en abrégé) sont les pierres angulaires de l'écriture d'un code évolutif et facile à maintenir.
• 05 Faciliter les tests
  La testabilité des logiciels est particulièrement importante. Un bon code doit être facile à tester, à la fois en essayant de réduire la complexité de chaque composant et en soutenant les tests automatisés pour s'assurer qu'il se comporte comme prévu.
• 06 Abstraction
  L'abstraction nous oblige à extraire la logique de base et à dissimuler la complexité, ce qui rend le code plus souple et plus générique. Un bon code doit avoir un niveau d'abstraction modéré, sans être surdimensionné ni négliger l'extensibilité et la maintenabilité à long terme.
• 07 Utiliser des modèles de conception, mais ne pas surconcevoir
  Les modèles de conception peuvent nous aider à résoudre certains problèmes courants. Cependant, chaque modèle a ses propres scénarios d'application. La surutilisation ou la mauvaise utilisation des modèles de conception peut rendre votre code plus complexe et difficile à comprendre.
• 08 Réduire les dépendances globales
  L'utilisation de variables et d'instances globales peut entraîner des dépendances et une gestion confuse de l'état. Un bon code doit s'appuyer sur un état localisé et le passage de paramètres. Les fonctions doivent être exemptes d'effets secondaires.
• 09 Refactorisation continue
  Un bon code est maintenable et extensible. Le remaniement continu réduit la dette technique en identifiant et en corrigeant les problèmes le plus tôt possible.
• 10 La sécurité est une priorité absolue
  Un bon code doit éviter les failles de sécurité les plus courantes.

1. Cet article est une reproduction du contenu de la lettre d'information de bytebytego. s'inscrire à leur lettre d'information si vous souhaitez en savoir plus ↩︎