Formatierung

Aus RAD Studio
Wechseln zu: Navigation, Suche

Nach oben zu C++-Optionen


Tools > Optionen > Sprache > C++ > Formatierung

C++-Formatoptionen

Die Codeformatierung wird zum Ändern des Layouts des Quelltextes verwendet: Dies sind stilistische Entscheidungen, wie z. B. wo Sie Zeilenumbrüche einfügen, wo Klammern stehen, wie viel und was eingerückt wird usw.

In der Regel geschieht dies, um einem bestimmten Codierungsstandard zu entsprechen, entweder einem allgemeinen, Ihrem eigenen oder einem Unternehmensstandard. C++Builder implementiert dies durch das Clang-Format-Tool.

Formatieren Sie Code im Editor für ausgewählten Code, eine ganze Unit oder über ein Befehlszeilentool. In der IDE es ist nützlich, um den Code zu formatieren, an dem Sie gerade arbeiten. Das Befehlszeilentool ist für die automatische Formatierung beim Übertragen von Code, die Formatierung Ihres Codes in großen Mengen oder ähnliche Vorgänge hilfreich.

Auf den Seiten unter C++ können Sie Optionen festlegen, die in C++-Projekten für C/C++-Quelltextdateien mit den folgenden Erweiterungen verwendet werden: *.cpp, *.cxx, *.cc, *.c, *.hpp, *.hxx, *.hh, *.h.

Formatierungsverhalten

Element Beschreibung

Automatische Formatierung

Formatieren Sie Ihren Code manuell oder automatisch beim Speichern oder formatieren Sie bei einer neuen Zeile. Wählen Sie unter folgenden Optionen aus:

  • Nicht automatisch: Formatiert Code nur, wenn Sie die Formatierung manuell durch Drücken von Strg+D aufrufen. Die Formatierung formatiert den ausgewählten Code im Editor oder die gesamte Datei, wenn Sie nichts auswählen.
  • Beim Speichern formatieren: Formatiert Code beim Speichern der Datei.
  • Bei neuer Zeile formatieren: Formatiert Code jedes Mal, wenn Sie die Eingabetaste drücken, um eine neue Zeile hinzuzufügen.

Bei Zeilengrenze der neuen Zeile formatieren

Bei Auswahl der automatischen Formatierung für eine neue Zeile wird die Formatierung nicht aufgerufen und die Formatierung wird nicht angewendet, wenn der Code länger als diese Anzahl von Zeilen ist. Der Grund dafür ist, dass Clang-Format für die Formatierung längerer Units deutlich mehr Zeit benötigt. Die Standardeinstellung ist 1000.

Formatierungsstil

Klicken Sie auf das Dropdown-Menü, um die Liste der vordefinierten Formatierungsstile anzuzeigen: LLVM, Google, Chromium, Mozilla, WebKit und Embarcadero. Die Vorgabe ist Embarcadero. Benutzerdefinierte Formatierung Sie können Clang-Format-Voreinstellungen erstellen, die in dieser Einstellung angezeigt werden, genau wie die standardmäßigen Einstellungen "Embarcadero", "Mozilla" usw., oder überschreiben Sie die Formateinstellungen auf Projektebene. Überschreibungen auf Projektebene Die Clang-Format-Konvention sieht vor, dass der Formatierungsstil für Projekte in einer .clang-format-Konfigurationsdatei im Quellcode-Ordner angegeben ist (beachten Sie, dass der Dateiname mit einem Punkt beginnt). Wenn die IDE eine .clang-format-Konfigurationsdatei findet, die mit Ihrer Projektquelle verknüpft ist, verwendet sie diese Formatierung bei der Formatierung von Code. Wenn keine Konfigurationsdatei gefunden wird, verwendet die IDE den durch diese Einstellung definierten Stil als Fallback. Das bedeutet, dass die Einstellungen der IDE verwendet werden, sofern sie nicht auf Projektebene überschrieben werden, und dass die IDE Überschreibungen auf Projektebene beachtet, indem sie eine .clang-format-Datei bereitstellt. Dies ist in Open-Source-C++-Bibliotheken üblich. Neue IDE-weite Konfiguration Sie können neue Konfigurationsdateien erstellen, in denen Formatierungsoptionen gespeichert werden, und sie der IDE als Fallback für alle Projekte zur Verfügung stellen. Dazu muss die Datei:

  • Der Dateimaske Formatter_*.clang-format entsprechen.
  • Im Arbeitsverzeichnis von RAD Studio vorhanden sein: C:\Users\<Benutzername>\AppData\Roaming\Embarcadero\BDS\23.0.

Dadurch wird der Name der Formatierung als Option in der Einstellung "Formatierungsstil" angezeigt. Bearbeiten oder erstellen Sie Dateien auf Grundlage von vorhandenen Konfigurationen. Weitere Informationen zum Schreiben einer Konfigurationsdatei finden Sie unter Clang Format Style Options (Englisch).

Hinweis: Neue Dateien werden im Dropdown-Menü "Formatierungsstil" beim nächsten Starten der IDE angezeigt.

Bestätigungsdialogfeld anzeigen

Wenn diese Option ausgewählt ist, wird eine Aufforderung zur Bestätigung angezeigt, wenn Sie einen Formatierungsbefehl ausführen.

Verhindern der Formatierung

Verhindern Sie die Formatierung bestimmter Abschnitte, indem Sie den Code, den Sie nicht formatieren möchten, wie folgt in Kommentare einschließen: 

// clang-format off
Code here will not be formatted
// clang-format on

Wenn Sie die Formatierung über einen Kommentar ausschalten, wird die Formatierung angehalten, bis der nächste "on"-Kommentar gefunden wird. Sie können Kommentare im Einzeilenformat (//) oder im Mehrzeilenformat (/**/) verwenden.

Clang-Format-Befehlszeile

Sie können die Formatierung über die Befehlszeile aufrufen. Das Programm heißt clang-format.exe. Clang-Format bietet keine Option zur Auswahl einer Formatierungskonfigurationsdatei und sucht immer nach einer lokalen .clang-format-Datei. Um den Embarcadero-Formatierungsstil zu verwenden, müssen Sie also Embarcadero.clang-format in Ihren Quellordner kopieren und in .clang-format umbenennen.

Siehe auch

Abgerufen von „https://docwiki.embarcadero.com/RADStudio/Athens/d/index.php?title=Formatierung&oldid=218415“