Herunterladen Inhalt Inhalt Diese Seite drucken

Richtlinien Zur Quelltextformatierung; Vorteile Der Einheitlichen Formatierung; Kommentare - Conrad C-Control II Unit Handbuch

Kompakter steuerungscomputer
Inhaltsverzeichnis

Werbung

C-Control II Unit

6.3 Richtlinien zur Quelltextformatierung

6.3.1 Vorteile der einheitlichen Formatierung

Für die syntaktische und funktionale Korrektheit eines Programms ist die Formatierung eines
Quelltextes ohne Bedeutung. Im Interesse der Übersichtlichkeit und der Verständlichkeit
sollten Quelltexte jedoch auch "optisch" korrekt sein. Ein stilvoll und diszipliniert gestalteter
Quelltext nach einheitlichen Richtlinien ist auch nach längerer Zeit und auch für andere
Programmierer lesbar und nachvollziehbar. Formatierte Quelltexte enthalten in der Regel
von Anfang an weniger Fehler. Wenn sie Fehler enthalten, ist deren Suche und Beseitigung
einfacher an einem sauberen Quelltext durchführbar.
Nachfolgende Richtlinien sind Gestaltungsvorschläge. Es steht Ihnen frei, die Vorschläge
anzunehmen, zu variieren oder zu verwerfen. Wenn Sie jedoch Unterstützung von Conrad
Electronic wünschen und dazu Quelltextauszüge zur Überprüfung einsenden, können
diese nur bearbeitet werden, wenn sie den unten aufgeführten Richtlinien erkennbar
entsprechen. Im Zweifel orientieren Sie sich bitte an der Formatierung der Standardmodule
und Beispiele auf der CD zur C-Control II Unit.

6.3.2 Kommentare

1. Ein Programm soll Kommentare enthalten, wenn das zur wesentlichen Verbesserung
der Verständlichkeit führt.
2. Ein Kommentar ist zu vermeiden, wenn der Sinn von Anweisungen auch durch selbst-
beschreibende Bezeichner deutlich werden kann.
3. Kommentare sollen nicht trivial sein, z.B. x = 1; // 1 an x zuweisen
4. Zeilenendkommentare sollen zumindest für Folgen von Anweisungen, die nicht durch
Leerzeilen getrennt sind, linksbündig untereinander stehen.
5. Ein erläuternder Kommentar zu einer Folge von Anweisungen steht in einer eigenen
Zeile vor diesen Anweisungen, mit derselben Einrückung wie diese Anweisungen.
6. Kommentare sind in einer einzigen Sprache verfaßt, z.B. einheitlich englischsprachig
oder einheitlich deutschsprachig. Kommentare sind in derselben Landessprache wie
die Bezeichner zu formulieren.
88

Werbung

Inhaltsverzeichnis
loading

Inhaltsverzeichnis