Thema: code-quality
-
Bezeichner so benennen, dass sich Code wie Absicht liest
Namen wählen, die im Vokabular der Domäne sagen, was etwas ist oder tut, in einer zur Sichtbarkeit proportionalen Länge; Kodierungen, Abkürzungen und irreführende Typangaben vermeiden und umbenennen, sobald sich das Verständnis verbessert.
-
Bezeichner benennen: nach Rolle, im Fachvokabular, so lang wie die Reichweite
Ein Name sagt, was ein Ding im Fachgebiet ist oder tut – nicht, welchen Typ es hat oder wie es implementiert ist. Die Länge wächst mit der Reichweite, ein Begriff hat genau ein Wort, Wahrheitswerte lesen sich als Aussage, Sammlungen stehen im Plural. Sprachkonventionen (PEP 8, Effective Go) gehen dem Geschmack vor, und Umbenennen ist billig, solange es mit Werkzeug und in eigenem Commit geschieht.
Maschinenlesbar: JSON