Sujet : code-quality
-
Nommer les identifiants pour que le code exprime l'intention
Choisir des noms qui énoncent ce qu'une chose est ou fait, dans le vocabulaire du domaine, avec une longueur proportionnelle à leur portée ; éviter les encodages, les abréviations et les types trompeurs, et renommer à mesure que la compréhension s'améliore.
-
Nommer les identificateurs : selon le rôle, dans le vocabulaire du domaine, aussi long que la portée
Un nom dit ce qu'une chose est ou fait dans le domaine — pas quel type elle a ni comment elle est implémentée. La longueur croît avec la portée, un concept correspond à exactement un mot, les valeurs booléennes se lisent comme une affirmation, les collections sont au pluriel. Les conventions du langage (PEP 8, Effective Go) priment sur le goût personnel, et renommer coûte peu tant que cela se fait avec un outil et dans un commit dédié.
Lisible par machine : JSON