Suivez les normes
Meilleure pratique 3 - Suivez les normes définies, ne les créez pas
La plupart des organisations de logiciels standard maintiennent leurs normes de codage. Ces normes auraient été établies par des développeurs de logiciels bien expérimentés après avoir passé des années à développer des logiciels. Cela équivaut à suivre les traces de gens formidables laissés derrière eux.
Si votre organisation n'a pas de norme, je vous suggère de rechercher sur Internet les normes de codage de différents langages de programmation et vous en trouverez beaucoup. Une norme de codage fixerait les règles concernant divers attributs importants du code, quelques-uns sont énumérés ci-dessous:
- Convention de dénomination de fichier
- Convention de dénomination des fonctions et des modules
- Convention de dénomination des variables
- Historique, retrait, commentaires
- Directives de lisibilité
- Liste des choses à faire et à ne pas faire
Mais une fois défini, commencez à suivre la norme définie au lieu de la créer ou de la modifier chaque jour. Je dirais certainement:
Le code source est votre BÉBÉ!
Alors gardez-le propre, cohérent et beau. Quand je dis beau, cela signifie vraiment beau. Si votre code est beau, il sera facile pour les autres de le lire et de le comprendre. Si vous continuez à changer les règles de codage tous les jours, après quelques jours, vous ne serez plus en mesure de lire et de comprendre le code que vous avez écrit.