Abkürzungen
Artikel#: 00069
Datum: 2021-09-30
Autor: Radim
In jedem Dokument, in dem wir Abkürzungen verwenden, müssen wir diese Abkürzungen auch erklären.
Es empfiehlt sich, gleich zu Beginn des Dokuments eine Tabelle mit alphabetisch sortierten Abkürzungen und deren Bedeutung zu erstellen.
Jede im Programm verwendete Abkürzung muss ebenfalls erklärt werden!
Die Verwendung von Abkürzungen kann das Schreiben von Code kürzer, einfacher und schneller machen.
Es erschwert jedoch das Lesen und Verstehen des Codes.
Es ist in der Regel besser, Abkürzungen zu vermeiden.
Dies ist jedoch manchmal nicht möglich, da einige Programmobjekte (Bibliotheken, Funktionsbausteine, Strukturen ...) oder Variablennamen eine begrenzte maximale Länge haben.
Abkürzungen können für neue Teammitglieder eine harte Nuss sein.
Am besten schreiben wir alle Abkürzungen mit ihrer vollen Bedeutung in alphabetischer Reihenfolge in eine Textdatei, die wir direkt dem Projekt beifügen.
Jede neue Abkürzung, die im Programm verwendet wird, muss auch in diese Datei geschrieben werden.
Wenn jemand im Programm auf eine Abkürzung stösst, die er nicht versteht, kann er ihre Bedeutung in der Datei finden. :-)
© 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:
- Denke kritisch!
- Lerne von deiner Reise!
- Warum scheitern Automatisierungsprojekte?
- Verwende einen nützlichen Styleguide!
- Schreibe und akzeptiere nur lesbaren Code!
- Schreibe deine Best Practices und Prozesse auf!
- Ich sehe was, was du nicht siehst
- Mehr als nur starten und stoppen
- Mach die richtigen Dinge und mach sie richtig!
- Führt die Terminologie ein und vereinheitlicht sie!
- Verwirkliche jede gute Idee so schnell wie möglich!
- Kommunikationsfähigkeiten sind äusserst wichtig
- Überlege auf dem Papier!
- Schärfe deine Axt, bevor du beginnst zu fällen!
- Überprüfe das Ergebnis!
- Halte es einfach!
- Wähle das richtige Werkzeug!
- Entwicklung ist Evolution
- Vernachlässige und überspringe keinen Schritt!
- Transparenz und Zuverlässigkeit
Verwandte nächste Artikel:
- Variablennamen
- Wahl der Programmiersprache
- Dokumentationsprobleme
- SPS-Netzwerkdiagramm
- Halte die Dokumentation während des gesamten Projekts auf dem neuesten Stand
- Pflege Ordnung im Programmkode
- Codeformatierung
- Ein unersetzbarer Mitarbeiter
- Die falsche Illusion des schnellen Fortschritts
- Was macht eine HMI intuitiv?
Kommentar#: 00001
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#: 00002
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#: 00003
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.