Variablennamen

Artikel#: 00072

Datum: 2021-11-06

Autor: Radim

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_Hz
Loc_MotorSpeed_Acl_RevPerMin
Loc_MotorSpeed_Dsr_Hz
Loc_MotorTorque_Acl_Nm

© Radim-Automation, 2020–2025. Alle Rechte vorbehalten.
Die Verbreitung dieses Artikels ist mit Angabe der Quelle (Link zur Originalseite) ausdrücklich gestattet.

Verwandte vorherige Artikel:

• Maschinenmodularisierung
• Abkürzungen
• Modulare Softwarearchitektur
• Denke kritisch!
• Lerne von deiner Reise!
• Warum scheitern Automatisierungsprojekte?
• Verwende einen nützlichen Styleguide!
• Schreibe und akzeptiere nur lesbaren Code!
• Ernenne einen Vertreter!
• HMI- und SPS-Anwendungen sollen zusammenwachsen
• Willst du damit wirklich beginnen?
• Ich sehe was, was du nicht siehst
• Mehr als nur starten und stoppen
• Mach die richtigen Dinge und mach sie richtig!
• Alles ist schwierig, bis es einfach wird
• Führt die Terminologie ein und vereinheitlicht sie!
• Verwirkliche jede gute Idee so schnell wie möglich!
• Bleibe wachsam!
• Enttäuscht euren Kunden nicht!
• Kommunikationsfähigkeiten sind äusserst wichtig
• Entwickle Verantwortungsbewusstsein!
• Konzentriere dich auf das Ziel!
• Überlege auf dem Papier!
• Schärfe deine Axt, bevor du beginnst zu fällen!
• Überprüfe das Ergebnis!
• Halte es einfach!
• Verlass kein Arbeitspaket halbfertig!
• Erfolg ist kein Zufall
• Entwicklung ist Evolution
• Vernachlässige und überspringe keinen Schritt!
• Transparenz und Zuverlässigkeit
• Von einer Idee zu einem konsistenten System

Verwandte nächste Artikel:

• Wahl der Programmiersprache
• Ereignislogger als allererste im Programm implementierte Funktion
• Versionskontrollsystem
• Halte die Dokumentation während des gesamten Projekts auf dem neuesten Stand
• Pflege Ordnung im Programmkode
• Codeformatierung
• Traum von einem plattformunabhängigen SPS-Programm
• Die falsche Illusion des schnellen Fortschritts

Kommentar#: 00001

Datum: 2021-11-06

Benutzer: Radim

"Sie werden die richtige Benennung möglicherweise erst dann zu schätzen wissen, wenn Sie zu Code gelangen, den Sie verstehen müssen und der falsch benannte Variablen enthält."
- https://bonsai-development.cz/clanek/ve-spravnem-pojmenovani-promennych-je-sila

Kommentar#: 00002

Datum: 2021-11-06

Benutzer: Radim

"Auch wenn Sie eine Variable nur als temporären Wertespeicher verwenden, geben Sie ihr dennoch einen aussagekräftigen Namen."
- https://towardsdatascience.com/data-scientists-your-variable-names-are-awful-heres-how-to-fix-them-89053d2855be

Kommentar#: 00003

Datum: 2021-11-06

Benutzer: Radim

"Ihr Code wird öfter gelesen als geschrieben. Priorisieren Sie, wie leicht Ihr Code zu verstehen ist, anstatt wie schnell er geschrieben wird."
- https://towardsdatascience.com/data-scientists-your-variable-names-are-awful-heres-how-to-fix-them-89053d2855be

Kommentar#: 00004

Datum: 2021-11-06

Benutzer: Radim

"Insgesamt erhöhen Sie die Entwicklungszeit Ihres Programms, indem Sie versuchen, Code schneller zu schreiben – indem Sie kürzere Variablennamen verwenden!"
- https://towardsdatascience.com/data-scientists-your-variable-names-are-awful-heres-how-to-fix-them-89053d2855be

Kommentar#: 00005

Datum: 2021-11-06

Benutzer: Radim

"Verwenden Sie beschreibende Schleifen Indexes anstelle von i, j, k."
- https://towardsdatascience.com/data-scientists-your-variable-names-are-awful-heres-how-to-fix-them-89053d2855be

Kommentar#: 00006

Datum: 2022-07-06

Benutzer: Radim

Es ist sinnvoll, die Variablen so zu benennen, dass bei der Suche nach dem Namen der Variable im Programm nur die gesuchte Variable zurückgegeben wird. Dies kann beispielsweise durch die Verwendung des führenden Platzhalters '0' in Abhängigkeit von der Anzahl der Stellen in der Nummer erreicht werden. (Wenn ich z.B. nach 'Index1' suche, bekomme ich auch 'Index10' zurück. Daher ist es besser, die Variable 'Index01' zu nennen, wenn ich im Voraus weiss, dass ich mehr als 9 Indexe definieren werde, um Mehrdeutigkeiten zu vermeiden.)

Kommentar#: 00007

Datum: 2022-07-07

Benutzer: Radim

Benenne die Variablen ausserdem im gesamten Programm einheitlich, damit man dem 'Faden' leicht folgen und Vorkommen und Verwendungen der Variable im Programm finden kann. Dieser Tipp ist besonders wichtig, wenn eine Variable ihren Wert an eine andere Variable übergibt.

Kommentar#: 00008

Datum: 2022-11-30

Benutzer: Radim

Wenn wir eine Abkürzung für den Namen einer Variablen oder eines anderen Elements im Programm wählen müssen, ist es ratsam, eine solche Buchstabenkombination zu wählen, die ihre volle Bedeutung angibt, und es ist auch ratsam, eine solche Buchstabenkombination zu wählen dass, wenn wir das Programm nach Vorkommen dieser Abkürzung durchsuchen, es nichts als alle Vorkommen dieser Abkürzung zurückgibt. Das bedeutet, dass die Abkürzung in keinem Wort vorkommen sollte, das im Programm verwendet wird, daher ist eine globale Suche nach dieser Abkürzung im gesamten Programm hilfreich.

Kommentar#: 00009

Datum: 2023-04-11

Benutzer: Radim

IEC 61131-3: Coding Guidelines
- Sehen Sie mehr auf: https://stefanhenneken.net/2016/01/09/iec-61131-3-coding-guidelines/

Kommentar#: 00010

Datum: 2023-09-27

Benutzer: Radim

"Indem wir das Design des Codes kontinuierlich verbessern, machen wir es immer einfacher, damit zu arbeiten.
Dies steht in krassem Gegensatz zu dem, was normalerweise geschieht: wenig Refactoring und viel Aufmerksamkeit, um schnell neue Funktionen hinzuzufügen.
Wenn man sich die hygienische Angewohnheit angewöhnt, kontinuierlich zu refaktorisieren, wird man feststellen, dass es einfacher ist, den Code zu erweitern und zu pflegen."

Übersetzt von:
- Joshua Kerievsky. Addison-Wesley (2004). Refactoring to Patterns.

Kommentar#: 00011

Datum: 2024-02-22

Benutzer: Radim

Ist Ihre Muttersprache nicht Englisch und arbeiten Sie in einem internationalen Team? Haben Sie sich im Team auf Englisch als Projektsprache geeinigt? Dann bitte:

1. Installieren und benutzen Sie alle Projektwerkzeuge auf Englisch.
2. Verwenden Sie englische Hilfedateien für die Werkzeuge.
3. Schreiben Sie englische Variablennamen und Kommentare in den Code.

Diese Regeln erleichtern die Zusammenarbeit zwischen den Teammitgliedern, die Dokumentation und die Supportaufgaben. Denn die Leute werden die gleichen Begriffe verwenden.

Sind Sie mit diesen Regeln einverstanden?
Würden Sie noch etwas hinzufügen?

Kommentar#: 00012

Datum: 2024-03-25

Benutzer: Radim

Es gibt einige Vorteile des alphabetischen Sortierens von Variablen innerhalb eines Deklarationsblocks:

1. Einfacheres Suchen: Wenn Variablen alphabetisch sortiert sind, ist es einfacher, eine bestimmte Variable zu finden, weil du weisst, dass sie an einer bestimmten Stelle in alphabetischer Reihenfolge stehen wird.

2. Schnellere Aktualisierungen und Modifikationen: Beim Aktualisieren oder Modifizieren vorhandener Variablen ist es einfacher, die entsprechende Variable zu finden, wenn die Variablen alphabetisch sortiert sind.

3. Einfacheres Erstellen neuer Variablen: Beim Erstellen neuer Variablen kannst du einfacher einen geeigneten Namen auswählen, wenn du einen Überblick über alle vorhandenen Variablen und ihre alphabetische Reihenfolge hast.

4. Code-Klarheit und Wartung: Das alphabetische Sortieren von Variablen trägt zur Klarheit des Codes bei und erleichtert dessen Wartung, weil der Programmierer weiss, wo er nach einer bestimmten Variable suchen muss.

Es ist jedoch wichtig, sich an konsistente Regeln für das Benennen von Variablen zu halten.

Kommentar#: 00013

Datum: 2024-04-10

Benutzer: Radim

"Codekonventionen sind für Programmierer aus mehreren Gründen wichtig:

• 40%-80% der Lebenszeitkosten einer Software entfallen auf die Wartung.

• Kaum eine Software wird während ihrer gesamten Lebensdauer vom ursprünglichen Autor gewartet.

• Codekonventionen verbessern die Lesbarkeit der Software und ermöglichen es den Ingenieuren, neuen Code schneller und gründlicher zu verstehen.

• Wenn Sie Ihren Quellcode als Produkt ausliefern, müssen Sie dafür sorgen, dass er genauso gut verpackt und sauber ist wie jedes andere Produkt, das Sie erstellen."

- https://en.wikipedia.org/wiki/Coding_conventions
(übersetzt aus dem Englischen)