Skip to content

Erhöhung der Lesbarkeit

Automatische Formatierung

Die Jedi Formatierung wurde abgelöst durch die RAD Studio interne Lösung. Hier gibt es mehr Einstellmöglichkeiten.

Quelle: Ourplant Projekt:

\scripts\formatter
  - Formatter_Ourplant.config

Speichern in:

C:\Users\%USERNAME%\AppData\Roaming\Embarcadero\BDS\12.0\

Im RAD Studio:

Tools ► Optionen ► Formatierung ► Profile und Status ► Formatter_Ourplant.config laden!

Anwendung

  • rechte Maustaste im Quellcode und Quelltext formatieren wählen
  • Es können auch einzelne Funktionen allein formatiert werden, in diese vorher markiert werden

Empfehlung

  • formatiere neue Funktionen
  • formatiere den kompletten Text nur bei neuen Dateien
  • unbedingt vermeiden: Bugfixing verbinden mit Textformatierung. Änderungen sind kaum nachzuvollziehen

Verwendung des Leerzeichens

Leerzeichen sollten nicht verwendet werden:

  • zwischen einem Methodennamen und seiner öffnenden Klammer,
  • vor oder nach einem . (Punkt)-Operator,
  • zwischen einem einstelligen Operator und seinem Operanden,
  • zwischen einer Typumwandlung (cast) und dem Ausdruck, der umgewandelt werden soll,
  • nach einer öffnenden Klammer oder vor einer schließenden Klammer,
  • nach einer öffnenden eckigen Klammer [ oder vor einer schließenden eckigen Klammer ] oder
  • vor einem Semikolon.

Leerzeilen

Leerzeilen können die Lesbarkeit erhöhen, indem Code-Abschnitte gebildet werden, die logisch zusammengehören. Leerzeilen sollten außerdem an folgenden Stellen verwendet werden:

  • Nach dem Copyright-Kommentarblock, der Package-Deklaration und dem Import-Abschnitt,
  • zwischen Klassendeklarationen und
  • zwischen Methodendeklarationen.

Copyright © 2021 Häcker Automation