Definition und Zweck:
Ein Kommentar (engl. Comment) ist ein Textabschnitt innerhalb eines Programmcodes oder einer Konfigurationsdatei, der nicht von der Steuerung oder dem Compiler ausgeführt wird. Er dient ausschließlich dazu, den Code für menschliche Leser zu erklären, zu erläutern und zu dokumentieren.
Der Hauptzweck von Kommentaren ist die Verbesserung der Lesbarkeit und Verständlichkeit von Software. Sie helfen Programmierern, die Logik, die Absicht und die Funktionalität komplexer Code-Abschnitte schnell zu erfassen, insbesondere wenn sie zu einem späteren Zeitpunkt (oder von anderen Personen) gewartet oder erweitert werden müssen.
Anwendung in der SPS-Programmierung:
In der SPS-Programmierung sind Kommentare von entscheidender Bedeutung, da SPS-Programme oft über lange Zeiträume in Betrieb sind und von verschiedenen Programmierern oder Servicetechnikern bearbeitet werden:
- Erklärung der Logik: Kommentare erläutern, warum bestimmte Entscheidungen im Programm getroffen wurden, welche Bedingungen zu erfüllen sind oder welche Algorithmen verwendet werden.
- Funktionsweise von Bausteinen: Beschreibung des Zwecks von Funktionen (FC), Funktionsbausteinen (FB) oder Organisationsbausteinen (OB).
- Variablenbeschreibung: Zusätzliche Informationen zu Variablen (z.B. Wertebereich, physikalische Einheit, Verwendungszweck).
- Versionsinformationen: Dokumentation von Änderungen (Datum, Autor, Art der Änderung).
- To-Do-Listen: Markierung von Stellen, die noch überarbeitet oder implementiert werden müssen.
Syntax (Beispiele):
Die Syntax für Kommentare variiert je nach Programmiersprache und SPS-Hersteller:
- Strukturierter Text (ST):
(* Dies ist ein einzeiliger Kommentar *)oder// Dies ist ein einzeiliger Kommentar. Mehrzeilige Kommentare mit `(* … *)`. - Kontaktplan (KOP) / Funktionsplan (FUP): Kommentare können direkt in den Netzwerken oder an den Bausteinen platziert werden.
Bedeutung für Softwarequalität:
Eine gute Kommentierung ist ein Qualitätsmerkmal professioneller Softwareentwicklung und trägt maßgeblich bei zu:
- Wartbarkeit: Erleichtert die Fehlersuche und das Verständnis des Codes, reduziert den Aufwand für zukünftige Änderungen.
- Wissenstransfer: Ermöglicht neuen Mitarbeitern eine schnellere Einarbeitung in bestehende Projekte.
- Fehlerreduzierung: Verringert das Risiko, dass bei Änderungen unbeabsichtigte Fehler eingeführt werden.
- Teamarbeit: Verbessert die Zusammenarbeit in Entwicklerteams.
Kommentare sind die „Dokumentation im Code“ und sollten sorgfältig und aktuell gehalten werden.
→ Siehe auch: Inline-Dokumentation, Kommentierung, SPS-Programmierung, Softwarequalität
