Home » Object Pascal » Styleguide

Styleguide

Einführung

Dieses Dokument hat nicht die Absicht, eine Grammatik für die Delphi-Sprache zu definieren. Es ist zum Beispiel nicht erlaubt, einen Strichpunkt vor eine else-Anweisung zu setzen; der Compiler lässt das einfach nicht zu. Deshalb werde ich diese Regel nicht in diesem Styleguide auslegen. Dieses Dokument möchte eine saubere Vorgehensweise an Stellen, an denen die Sprache einem Wahlmöglichkeit gibt, festlegen. Ich werde in der Regel nichts über Sachen sagen, die nur auf eine Art behandelt werden können.

Hintergrund

Die Richtlinien, die hier dargestellt werden, basieren auf dem öffentlich zugänglichen Teil des Delphi-Quellcodes. Der Delphi-Quellcode sollte diesen Richtlinien präzise folgen. Wenn Sie Stellen finden, an denen der Quellcode von diesen Richtlinien abweicht, dann sollten Sie diese Richtlinien und nicht den fehlerhaften Quellcode als Standard nehmen. Nichtsdestoweniger sollten Sie den Quellcode als eine Unterstützung dieser Richtlinien verwenden, zumindest soweit er Ihnen dabei helfen kann, ein grundsätzliches Gespür dafür zu geben, wie Ihr Code aussehen sollte.

Anmerkungen

Das Format dieses Dokuments und ein Teil seiner Sprache basiert auf einer Arbeit, die einen Style-Standard für die Sprache Java definiert. Java hatte keinen Einfluss auf die Regeln zur Formatierung der Delphi-Sprache, aber die Dokumente, die wir auf der Sun-Website gefunden haben, stellen die Basis für dieses Dokument dar. Insbesondere der Stil und die Formatierung dieses Dokuments wurden sehr beeinflusst durch „A Coding Style Guide for Java WorkShop and Java Studio Programming“ von Achut Reddy. Jenes Dokument kann unter folgender URL gefunden werden: http://www.sun.com/workshop/java/wp-coding.
Das Delphi-Team trug ebenfalls sehr viel zu der Erstellung dieses Dokuments bei, und es wäre tatsächlich nicht möglich gewesen, es ohne seine Hilfe zu erstellen.

Dieser Styleguide ist eine Übersetzung aus dem Amerikanischen. Das Original von Charles Calvert, das den einzigen offiziellen Styleguide darstellt, befindet sich unter http://edn.embarcadero.com/article/10280.

Anzeigen

Schreibe einen Kommentar

Deine E-Mail-Adresse wird nicht veröffentlicht. Erforderliche Felder sind markiert *

Fragen und Anregungen können gerne im Forum gepostet werden. Die hierfür vorgesehene Sparte ist Delphi-Treff>>Feedback.