Dein Warenkorb ist gerade leer!

Variablennamen
Eine Variable ist ein Speicherort für Daten.
Wir sollten einen Namen für die Variable wählen, der am besten beschreibt, wofür die Variable verwendet wird und welche Daten in der Variable gespeichert werden.
Der Nutzen korrekter Variablennamen wird oft unterschätzt und der Auswahl geeigneter Variablennamen wird zu wenig Aufmerksamkeit und Zeit gewidmet.
Der Name jeder Variable sollte so sein, dass kein Kommentar oder zusätzliche Erläuterung erforderlich ist.Er muss leicht lesbar und ausreichend beschreibend sein. Je klarer die Variablennamen sind, desto klarer das gesamte Programm ist.
Was sollte die optimale Länge des Variablennamens sein?
Es muss festgestellt werden, ob die Entwicklungsumgebung die Länge der Namen von Variablen und anderen Objekten im Programm begrenzt.
Wenn immer möglich, ist es besser, keine oder nur sehr wenige Abkürzungen zu verwenden. Wenn wir eine Abkürzung wählen müssen, damit der Variablenname nicht zu lang wird, erscheinen drei Buchstaben angemessen (weder zu viele noch zu wenig), um das Wort im Variablennamen zu kürzen.
Die optimale Länge des Variablennamens wird so gewählt, dass der Name aussagekräftig genug und gleichzeitig gut lesbar, dh nicht zu lang ist.
Klein- oder Grossbuchstaben?
Pascal Case (auch bekannt als Upper Camel Case) – ein Wortaufbau ohne Leerzeichen, bei dem jedes Wort mit einem Grossbuchstaben beginnt – ist meiner Meinung nach eine gute Wahl für ein ausgewogenes Verhältnis zwischen Platzersparnis und Lesbarkeit.
Wenn wir im Namen der Variablen ein Wort mehr trennen möchten, können wir auch einen Unterstrich verwenden.
Soll der Variablenname auch den Datentyp der Variablen enthalten?
Meiner Meinung nach nicht.
Vermutlich gab es in der Vergangenheit Gründe für die Einbettung des Datentyps in einen Variablennamen, wenn die Entwicklungsumgebung den Programmierer beim Bewegen des Mauszeigers über die Variable nicht im Tooltip über den Variablentyp informiert hat.
Heute macht es meiner Meinung nach keinen Sinn mehr, den Datentyp in den Variablennamen zu schreiben. Es nimmt unnötigen Platz ein, erschwert das Lesen und erhöht den Arbeitsaufwand, wenn wir uns entscheiden, den Datentyp einer Variablen zu ändern.
Was sollte der Variablenname noch enthalten?
Es ist sinnvoll, im Variablennamen ein Präfix zu verwenden, um anzugeben, ob es sich um eine globale, lokale, Eingang- oder Ausgangvariable handelt (z.B. Glo_, Loc_, Inp_, Out_).
Istwert und dessen Sollwert können im Programm den gleichen Variablennamen mit der Unterscheidung am Ende des Variablennamens haben (z.B. _Acl für Istwert („actual value“) und _Dsr für Sollwert („desired value“)).
Enthält die Variable den Wert einer Grösse mit einer bestimmten Einheit, ist es vorteilhaft, die Einheit in den Variablennamen zu schreiben, um Zweifel zu vermeiden. Es kommt oft vor, dass wir im Programm eine Grösse von einer Einheit in eine andere umrechnen, also haben wir zwei Variablen und jede wird durch ihren Namen bestimmt (z.B. Speed_Hz und Speed_RevPerMin).
Wie setzen wir den Variablennamen zusammen?
Wörter im Variablennamen sollten die Variable von allgemein links bis genauer rechts beschreiben. Auf diese Weise werden die Namen der Variablen symmetrisch – der Beginn der Variablen ist bei den Variablen, die miteinander in Beziehung stehen, gleich und wenn sie in der Deklaration alphabetisch untereinander geordnet sind, ist es einfacher, sich einen Überblick zu verschaffen, welche Variablen verwendet werden. z.B.:Loc_MotorSpeed_Acl_HzLoc_MotorSpeed_Acl_RevPerMinLoc_MotorSpeed_Dsr_HzLoc_MotorTorque_Acl_Nm
Tags:

Schreibe einen Kommentar