Page Revision for Bonne pratiques

Eviter d'utiliser des nombres random dans le code et les remplacer par des constantes

Ne pas abréger le noms des méthodes ou le nom des variables

Ne pas répèter les types dans les noms des variables

Spécifier les unités dans les variables, ou mieux, créer un type qui le représente

Eviter d'utiliser des noms/préfixes génériques tel que "I", "Utils", "Helper", "Abstract" dans les noms des classes

Il n'est pas nécessaire de donner des informations sur les détails de fonctionnement (par exemple écrire "Interface" ou "I" dans le nom d'une interface n'est pas nécessaire)

Eviter d'utiliser trop de commentaires, car ils peuvent devenir obsolètes et ne sont pas nécessaire quand le code est proprement documenté. A la place essayer de rendre le code si clair qu'il s'exprimme comme le commentaire.

Utiliser des commentaires quand l'implémentation semble quelque peu bizarre (par exemple pour des raisons d'optimisation)

Les conditions peuvent être extraites dans des méthodes séparées

Utiliser des enums pour tous les états fixent pour empécher des états impossibles d'être représenter

Si possible utiliser des types tel que "Option" ou "Result" pour obliger de prendre en compte les cas de valeurs null ou d'erreurs

Eviter d'utiliser plus de 3 niveau d'intendation dans une méthode

Extraire des bouts d'une méthode dans plusieurs autres
Notter les conditions d'une méthode au desus (cela permet de supprimer les else)

Ecrire une documentation (comment utiliser le code) de très bonne qualité et la garder à jour.

Décrire le but d'une classe et des interfaces et ce qu'elle représente
Décrire les attentes que les interfaces ont par rapport à leurs implémentations (comment elles doivent gérer X ou Y)
Décrire les buts des méthodes, leurs préconditoins et leurs post-conditions