Embarcadero hat gerade auf der docwiki-Website eine aktualisierte Version des Sprachstil-Leitfadens veröffentlicht. Das Dokument wurde aktualisiert, um moderne Delphi-Sprachfunktionen und einige Änderungen am Codierungsstil abzudecken
In den letzten Monaten habe ich mich bemüht, einen neuen Object Pascal-Styleguide für die heutige Delphi-Sprache zu veröffentlichen. Aus dem Vorwort:
„Dieses Dokument ist eine aktualisierte Version des klassischen Object Pascal-Styleguides, der ursprünglich von Charlie Calvert für Borland kuratiert wurde, als Delphi ursprünglich veröffentlicht wurde. Die aktualisierte Version wurde von Delphi-Produktmanager Marco Cantu mit Beiträgen des internen Forschungs- und Entwicklungsteams, der Delphi-MVPs und der gesamten Delphi-Community kuratiert. “
Der Text ist kein Sprachhandbuch, sondern behandelt die Verwendung von Leerzeichen und Formatierungen beim Schreiben von Code – etwas, das der Compiler im Allgemeinen ignoriert. Hier ist nichts obligatorisch, dies ist nur eine Empfehlung, um die Lesbarkeit zu verbessern. Das Befolgen dieser Regeln ist eine Voraussetzung für unser eigenes internes Team und jeden Mitwirkenden.
Sie finden den Styleguide unter http://docwiki.embarcadero.com/RADStudio/Sydney/en/Delphi’s_Object_Pascal_Style_Guide .
Dies ist der Dokumentindex:
- Einführung
- Allgemeine Regeln: Bezeichner, Schlüsselwörter, Einrückung
- Quellcodedateien, Einheiten und ihre Struktur
- Leerraumnutzung
- Bemerkungen
- Aussagen
- Typdeklarationen
Ich werde diesen Blog beenden und die kurze Einführung veröffentlichen:
Während die Delphi-Compiler im Allgemeinen Leerzeichen ignorieren und eine große Flexibilität beim Schreiben von Code durch einen Entwickler ermöglichen, hat Embarcadero für die Lesbarkeit und Wartbarkeit des Quellcodes eine Reihe von Richtlinien definiert, die von der internen Forschung und Entwicklung sowie von allen an der Entwicklung beteiligten Entwicklern verwendet werden Projekt. Wir empfehlen der gesamten Delphi-Community, diesen Codierungs- und Formatierungsstil zu übernehmen.
Die Einführung der Originalversion dieses Dokuments drückt dies gut aus:
„Object Pascal ist eine wunderschön gestaltete Sprache. Eine seiner großen Tugenden ist seine Lesbarkeit. Diese Standards sollen die Lesbarkeit des Object Pascal-Codes verbessern. Wenn Entwickler die in diesem Handbuch beschriebenen einfachen Konventionen befolgen, fördern sie Standards, die allen Delphi-Entwicklern zugute kommen, indem sie einen einheitlichen Stil verwenden, der leicht zu lesen ist. Die Bemühungen, diese Standards durchzusetzen, erhöhen den Wert des Quellcodes eines Entwicklers, insbesondere während der Wartungs- und Debugging-Zyklen. “
Dieses Dokument bezieht sich nicht auf die Sprachsyntax und -grammatik oder erklärt diese nicht, da es sich nur auf die Definition des Codeschreibstils an Stellen konzentriert, an denen die Sprache Ihnen die Wahl lässt, indem viele verschiedene Optionen in Bezug auf Leerzeichen und Formatierung zugelassen werden.
Keine dieser Richtlinien ist in Stein gemeißelt und wir erwarten, dass sie sich im Laufe der Zeit zusammen mit der Sprache weiterentwickeln.
Design. Code. Compile. Deploy.
Start Free Trial Upgrade Today
Free Delphi Community Edition Free C++Builder Community Edition
