Die Regeln der Programmierung

Regel 3. Ein guter Name ist die beste Dokumentation

Diese Arbeit wurde mithilfe von KI übersetzt. Wir freuen uns über dein Feedback und deine Kommentare: [e-mail]

Du kannst natürlich nicht über das Programmieren schreiben, ohne Shakespeare zu zitieren. Das ist schon fast ein Klischee. Trotzdem, hier ist Romeo und Julia, eine kurze Zusammenfassung: Romeo und Julia sind verliebte Teenager, die durch die Feindschaft zwischen ihren beiden Familien daran gehindert werden, ein glückliches Leben miteinander zu verbringen. Es endet für alle Beteiligten schlecht.

Akt II, Szene II. Im fünftberühmtesten Zitat des Stücks beklagt sich Julia über die Situation:

Was verbirgt sich hinter einem Namen? Das, was wir eine Rose nennen würde mit jedem anderen Namen genauso süß duften

Ich habe ähnliche Argumente über Code gehört, meist von Kollegen, die von meiner pingeligen Einstellung bei der Codeüberprüfung frustriert waren, was die Namensgebung angeht. Variablen, Funktionen, Mitglieder, Quelldateien, Klassen- und Strukturnamen - ich bin bei jedem von ihnen streitlustig.

Die Leute argumentieren, meist mit einem Augenrollen, dass der Name nicht wirklich wichtig ist, sondern dass es auf das ankommt, was benannt wurde. Die wahre Bedeutung einer Variablen (oder Funktion oder Klasse, was auch immer) lässt sich nur durch einen Blick in den Code herausfinden. Die wahre Bedeutung einer Variablen ist das, was sie repräsentiert - wie sie gesetzt wird, wie sie verwendet wird, nicht ...