Pflege Ordnung im Programmkode

Artikel#: 00088

Datum: 2024-03-05

Autor: Radim

Warum ist es wichtig, Ordnung im Programmkode zu pflegen?

1. Einfachere Lesbarkeit und Verständnis:
Kode, der gut organisiert und kommentiert ist, ist für andere Programmierer sowie für den Autor selbst leichter zu lesen. Eine einfache Struktur und klare Benennung von Funktionen und Variablen erleichtern das Verständnis dessen, was der Kode tut.

2. Weniger Fehler:
Bei der Wartung oder Hinzufügung neuer Funktionen ist es einfacher, Fehler in gut organisiertem Kode zu identifizieren und zu beheben. Chaotischer und inkonsistenter Kode erleichtert es, Fehler zu übersehen oder macht es schwierig, sie zu beheben, ohne das gesamte System zu verstehen.

3. Verbesserte Effizienz und Produktivität:
Gut organisierter Kode ermöglicht es Programmierern, schnell zu finden, was sie brauchen, und reduziert die Zeit, die benötigt wird, um bestehende Implementierungen zu verstehen. Dies führt zu einer grösseren Effizienz und Produktivität bei der Arbeit an dem Projekt.

4. Erleichtert die Zusammenarbeit:
Sauberer und gut dokumentierter Kode erleichtert die Zusammenarbeit zwischen Teammitgliedern. Wenn der Kode einfach zu lesen und zu verstehen ist, ist es einfacher, Informationen und Ideen zwischen den Teammitgliedern auszutauschen und zum Gesamtprojekt beizutragen.


Wie können wir Ordnung im Programmkode pflegen?

1. Regelmässig Kode kommentieren:
Kommentare sind entscheidend, um komplexe Teile des Kodes oder die Absicht hinter bestimmten Entscheidungen zu erklären. Regelmässiges Kommentieren des Kodes hilft nicht nur anderen, sondern auch dir selbst, wenn du nach einiger Zeit zum Kode zurückkehrst.

2. Konventionen und Standards einhalten:
Die meisten Sprachen und Frameworks haben empfohlene Codierkonventionen und -standards. Es ist wichtig, ihnen zu folgen, um sicherzustellen, dass dein Kode konsistent ist und für andere Programmierer leicht lesbar ist.

3. Kode in funktionale Blöcke unterteilen:
Die Unterteilung des Kodes in logische Blöcke und Funktionen erhöht die Modularität und erleichtert die Wiederverwendung des Kodes. Jede Funktion sollte einen klar definierten Zweck haben und so kurz wie möglich sein.

4. Sinnvolle Namen verwenden:
Es ist wichtig, Variablen, Funktionen und Klassen so zu benennen, dass ihr Zweck am besten widerspiegelt wird. Dies verbessert die Lesbarkeit und das Verständnis des Kodes.

5. Regelmässig Refaktorisieren:
Refaktorisierung ist der Prozess der Umstrukturierung vorhandenen Kodes, ohne sein externes Verhalten zu ändern. Regelmässiges Refaktorisieren hilft dabei, den Kode sauber zu halten und die Ansammlung technischer Schulden zu reduzieren.

Die Pflege der Ordnung im Programmkode sollte für jeden Programmierer eine Priorität sein.

© 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:

• Halte die Dokumentation während des gesamten Projekts auf dem neuesten Stand
• Versionskontrollsystem
• Diagnosetools
• Dokumentationsprobleme
• Visuelle Modellierung
• Wahl der Programmiersprache
• Variablennamen
• Maschinenmodularisierung
• Abkürzungen
• Modulare Softwarearchitektur
• Gibt es auch Nachteile?
• Denke kritisch!
• Warum scheitern Automatisierungsprojekte?
• Funktionelles und intuitives HMI
• Verwende einen nützlichen Styleguide!
• Schreibe und akzeptiere nur lesbaren Code!
• Wer weiss es?
• Ernenne einen Vertreter!
• HMI- und SPS-Anwendungen sollen zusammenwachsen
• Bereite einen guten Projektplan vor und halte ihn auf dem neuesten Stand!
• Ist der Weg wirklich das Ziel?
• 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!
• Definiere kontinuierlich Testszenarien und Testfälle!
• Alles ist schwierig, bis es einfach wird
• Führt die Terminologie ein und vereinheitlicht sie!
• Verwirkliche jede gute Idee so schnell wie möglich!
• Hab einen Experten zur Hand!
• Kommunikationsfähigkeiten sind äusserst wichtig
• Ersetze Mitarbeiter nicht in der Mitte des Projekts!
• Entwickle Verantwortungsbewusstsein!
• Rekrutiere und behalte die besten Mitarbeiter!
• Verstecke kein Problem!
• Überprüfe das Ergebnis!
• Halte es einfach!
• Entwicklung ist Evolution
• Vernachlässige und überspringe keinen Schritt!
• Transparenz und Zuverlässigkeit
• Von einer Idee zu einem konsistenten System

Verwandte nächste Artikel:

• Codeformatierung
• Mache Backups, nehme kleine Änderungen vor und teste viel
• Traum von einem plattformunabhängigen SPS-Programm
• Halte alles, was du brauchst, zusammen
• High Performance HMI
• Ein unersetzbarer Mitarbeiter
• Versteckte Gefahren bei der Inbetriebnahme
• Die falsche Illusion des schnellen Fortschritts

Kommentar#: 00001

Datum: 2024-03-06

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#: 00002

Datum: 2024-03-25

Benutzer: Radim

Entfernen Sie den "Ballast" aus dem Programm!

Bauen Sie nur die Dinge in das Programm ein, die wirklich benötigt werden. Unnötige Teile des Codes im Programm werden veraltet, ungetestet, werfen unnötige Fragen auf und sind eine Quelle der Unklarheit.

Manchmal ist es eine gute Idee, mehr als einen Weg in der Praxis auszuprobieren, um herauszufinden, welcher Weg der beste ist. Sobald wir uns jedoch für einen bestimmten Ansatz entschieden haben, ist es wichtig, unsere Methoden zu konsolidieren und die überholten zu entfernen. Indem wir "Ballast" aus dem Programm entfernen, beseitigen wir potenzielle Quellen der Verwirrung und verbessern die Gesamtqualität des Codes.

Kommentar#: 00003

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)