Le code

Voici des listes non exhaustives de bonnes pratiques et principes à respecter pour l'écriture du code.

Code propre

• Noms significatifs.
• Éviter la répétition.
• Clarté et simplicité.
• Éviter les chaînes magiques.
• Une classe par fichier.
• Indentation du code.

Ne garder que le code nécessaire, ce qui veut dire supprimer du code :

• Tous les fichiers non utilisés par l'application.
• Les parties de code en commentaires.
• Les commentaires inutiles (exemple : des explications de code provenant d'exemples).
• Le code qui a été utilisé pour déboguer (exemple : affichage dans la console).

Gestion des erreurs

Utiliser les mécanismes appropriés pour signaler et gérer les erreurs. Une exception ne doit jamais être relancée sans ajout de contexte.

Code sans avertissements et sans erreurs

Toujours remettre un code sans avertissements et sans erreurs. Ce peut être des avertissements et erreurs affichés dans la console du navigateur, dans le terminal de l'éditeur de code, etc.

Normes et standards

À moins d'un avis contraire, le code doit toujours respecter les normes et standards (nomenclature, standard d'écriture, etc.).

Principes POO

Quelques principes à suivre en programmation orienté objet :

• SOLID.
• CQRS: Command Query Separation.
• DRY: Don't repeat yourself.
• Tell don't ask.