Verwende einen nützlichen Styleguide!
Artikel#: 00056
Datum: 2021-03-11
Autor: Radim
Der Code muss für diejenigen, die ihn lesen, leicht zu lesen und für diejenigen, die ihn schreiben, leicht zu schreiben sein.
Ein Styleguide hilft dem Team, den Code einheitlich zu schreiben.
Neue Teammitglieder müssen nicht nach der Art und Weise suchen, wie sie den Code schreiben sollen, wenn die Regeln im Styleguide angegeben sind.
Der Styleguide ermöglicht es mehr Personen, in einem Team an einem Projekt zu arbeiten, sich mit Fremdcode vertraut zu machen und sich gegenseitig zu ergänzen.
Im Idealfall sieht der Code so aus, als ob er von einer Person geschrieben wurde, da dann jeder im Team damit vertraut ist.
Jedes Team sollte seine eigenen passenden Regeln für das Schreiben des Codes erstellen und aufschreiben.
Da eine schriftliche Beschreibung niemals alles enthalten wird, sollten Entwickler beim Lesen eines Fremdcodes auch die Schreibweise beachten und miteinander vereinheitlichen.
Wenn es allgemein akzeptierte Konventionen für eine Programmiersprache oder eine Entwicklungsumgebung gibt, stützt eure eigenen Regeln auf diese Konventionen.
Die Regeln müssen so einfach sein, dass die Teammitglieder nicht über sie nachdenken müssen.
Sobald das Regelwerk zu komplex ist, bietet es keine praktischen Vorteile mehr.
© 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:
- Schreibe und akzeptiere nur lesbaren Code!
- Wer weiss es?
- Ernenne einen Vertreter!
- Schreibe deine Best Practices und Prozesse auf!
- HMI- und SPS-Anwendungen sollen zusammenwachsen
- Willst du damit wirklich beginnen?
- Ich sehe was, was du nicht siehst
- Mach die richtigen Dinge und mach sie richtig!
- Mach es nicht schlimmer!
- Schreibe ein Projekttagebuch!
- Behaltet die Antworten auf die Frage "Warum"
- Alles ist schwierig, bis es einfach wird
- Führt die Terminologie ein und vereinheitlicht sie!
- Verwirkliche jede gute Idee so schnell wie möglich!
- Stelle Fragen!
- Kommunikationsfähigkeiten sind äusserst wichtig
- Ersetze Mitarbeiter nicht in der Mitte des Projekts!
- Entwickle Verantwortungsbewusstsein!
- Erledige die Dinge mit einem kleinen, motivierten Team!
- Konzentriere dich auf das Ziel!
- 9 Frauen können ein Baby nicht in einem Monat zur Welt bringen
- Schärfe deine Axt, bevor du beginnst zu fällen!
- Verstehen - Einverstanden sein - Identifiziert sein - Glauben
- Verstecke kein Problem!
- Überprüfe das Ergebnis!
- Halte es einfach!
- Verlass kein Arbeitspaket halbfertig!
- Entwicklung ist Evolution
- Vernachlässige und überspringe keinen Schritt!
- Transparenz und Zuverlässigkeit
Verwandte nächste Artikel:
- Funktionelles und intuitives HMI
- Lerne von deiner Reise!
- Modulare Softwarearchitektur
- Abkürzungen
- Maschinenmodularisierung
- Erkenntnisse aus einem abgeschlossenen Projekt sind unbezahlbar
- Variablennamen
- Wahl der Programmiersprache
- Dokumentationsprobleme
- Klare Signale
- Mein Chef war ein Held
- Versionskontrollsystem
- Halte die Dokumentation während des gesamten Projekts auf dem neuesten Stand
- Pflege Ordnung im Programmkode
- Codeformatierung
- Grafikdesigner
- Traum von einem plattformunabhängigen SPS-Programm
- Halte alles, was du brauchst, zusammen
- Ein unersetzbarer Mitarbeiter
- HMI – Übertreibt es nicht mit komplexem Design
- Die falsche Illusion des schnellen Fortschritts
Kommentar#: 00001
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#: 00003
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#: 00004
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#: 00005
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)