Freigeben über

Definieren konsistenter Codierungsstile mit EditorConfig

Um konsistente Codierungsstile für alle Benutzer zu erzwingen, die in einer Codebasis funktionieren, können Sie Ihrer Projektmappe oder Ihrem Projekt eine .editorconfig Datei hinzufügen. EditorConfig-Dateieinstellungen entsprechen einer von EditorConfig.orgverwalteten Dateiformatspezifikation. Viele Code-Editoren und -Anwendungen unterstützen EditorConfig-Dateien, einschließlich Visual Studio. Sie können mehrere .editorconfig Dateien verwenden und sie als Teil einer Codebasis einschließen.

Sie können eine EditorConfig-Datei manuell auffüllen oder basierend auf den in Visual Studio ausgewählten Codeformateinstellungen automatisch generieren. Weitere Informationen finden Sie unter Hinzufügen und Entfernen von EditorConfig-Dateien.

Wenn Sie Ihrem Projekt in Visual Studio eine EditorConfig-Datei hinzufügen, werden nur neue Codezeilen basierend auf den EditorConfig-Einstellungen formatiert. Die Formatierung des vorhandenen Codes wird nur geändert, wenn Sie die Befehle "Codebereinigung " oder " Dokument formatieren " ausführen. Weitere Informationen finden Sie unter Anwenden von Codeformatvorlagen.

Für .NET zeigt Visual Studio eine formatierte Version der .editorconfig Datei anstelle der Nur-Text-Datei an.

Screenshot der .editorconfig-Datei.

EditorConfig- und Code-Stil-Präferenzen

In Visual Studio haben die Einstellungen der EditorConfig-Datei Vorrang vor den verschiedenen globalen Texteditor-Einstellungen, die unter Tools>Options>Text Editor>[C# | C/C++ | Visual Basic]>Code Style. Sie können eine EditorConfig-Datei verwenden, um jede Codebasis so anzupassen, dass für dieses Projekt spezifische Text-Editor-Einstellungen verwendet werden.

Wenn Sie eine EditorConfig-Datei verwenden, können Sie weiterhin ihre eigenen persönlichen Editoreinstellungen im Text-Editor von Visual Studio festlegen. Diese Text-Editor-Einstellungen gelten, wenn Sie in einer Codebasis ohne EditorConfig-Datei arbeiten oder wenn die EditorConfig-Datei eine bestimmte Einstellung nicht überschreibt. Ein Beispiel für eine solche Einstellung ist, ob für den Einzugsstil im Code Tabs oder Leerzeichen verwendet werden.

Codekonsistenz

Mit EditorConfig-Dateieinstellungen können Sie konsistente Codierungsstile und -konventionen in einer Codebasis verwalten, unabhängig vom verwendeten Editor oder der verwendeten IDE. Einige Codierungsstile, die Sie steuern können, sind der Einrückungsstil, die Tabulatorbreite, die Zeichen am Zeilenende und die Codierung. Wenn Ihre C#-Codebasis beispielsweise eine Konvention aufweist, die fünf Leerzeichen einrückt, Dokumente UTF-8-Codierung verwenden und Zeilen mit CR/LF enden, können Sie eine EditorConfig-Datei so konfigurieren, dass diese Konvention verwendet wird. Informationen zu unterstützten Konventionen finden Sie unter "Unterstützte Einstellungen".

EditorConfig-Dateien sind nützlich, wenn Codierungskonventionen, die Sie für Ihre persönlichen Projekte verwenden, von den Konventionen abweichen, die für die Projekte Ihres Teams verwendet werden. Zum Beispiel könnten Sie es vorziehen, dass ein Einzug ein Tabulatorzeichen in Ihren Code einfügt. Ihr Team zieht jedoch möglicherweise vor, dass ein Einzug anstelle dessen vier Leerzeichen hinzufügt. EditorConfig-Dateien lösen dieses Problem, indem Sie eine Konfiguration für jedes Szenario haben können.

Da eine .editorconfig Datei in der Codebasis die EditorConfig-Einstellungen enthält, reisen sie zusammen mit dieser Codebasis. Solange Sie die Codedatei in einem EditorConfig-kompatiblen Editor öffnen, werden die Text-Editor-Einstellungen aktiviert.

Unterstützte Einstellungen

EditorConfig unterstützt alle von Visual Studio unterstützten Sprachen mit Ausnahme von XML.

Für jede Sprache unterstützt der Editor in Visual Studio den Kernsatz von EditorConfig-Eigenschaften:

  • indent_style
  • indent_size
  • Tabulatorbreite
  • Ende_der_Zeile
  • charset
  • trim_trailing_whitespace
  • insert_final_newline
  • wurzel

Für C# und Visual Basic unterstützt EditorConfig auch Codestilregeln , einschließlich Sprache, Formatierung und Benennung. Sie können z. B. eine C#-Sprachregel für die Verwendung von Var beim Definieren von Variablen angeben. Oder Sie können eine Benennungsregel festlegen, dass asynchrone Methodennamen ein "Async"-Suffix enthalten müssen.

Hinzufügen und Entfernen von EditorConfig-Dateien

Wenn Sie Ihrem Projekt oder Ihrer Codebasis eine EditorConfig-Datei hinzufügen, formatiert Visual Studio alle neuen Codezeilen, die Sie gemäß den EditorConfig-Dateieinstellungen schreiben. Visual Studio konvertiert jedoch keine vorhandenen Stile in die neuen, bis das Dokument formatiert oder Codebereinigungausgeführt wird. Wenn die Einzüge in Ihrer Datei beispielsweise mit Tabulatoren formatiert sind und Sie eine EditorConfig-Datei hinzufügen, die Einzüge mit Leerzeichen formatiert, werden die Einzugszeichen nicht automatisch in Leerzeichen umgewandelt. Wenn Sie das Dokument formatieren (wählen Sie Bearbeiten>Erweitert>Formatdokument aus, oder drücken Sie STRG+K, STRG+D), werden die Leerzeicheneinstellungen in der EditorConfig-Datei auf vorhandene Codezeilen angewendet.

Wenn Sie eine EditorConfig-Datei aus Ihrem Projekt oder Ihrer Codebasis entfernen, müssen Sie alle geöffneten Codedateien für die globalen Editoreinstellungen schließen und erneut öffnen, um neue Codezeilen zu beeinflussen.

Visual Studio verwendet automatisch EditorConfig-Dateien, die in einer Codebasis basierend auf der Ordnerhierarchie vorhanden sind.

Wenn keine EditorConfig-Datei vorhanden ist, können Sie dem Projekt eine Datei mit einer der folgenden Methoden hinzufügen.

Erzeugen einer EditorConfig aus Code-Style-Einstellungen

Sie können Ihre EditorConfig-Datei manuell auffüllen, oder Sie können die Datei basierend auf den von Ihnen im Dialogfeld "Optionen" von Visual Studio ausgewählten Codeformateinstellungen automatisch generieren. Diese Optionsseite ist unter Tools>Options>Text Editor> [C# | C/C++ | Visual Basic] >Code Style>General verfügbar. Klicken Sie auf Generate .editorconfig file from settings (Editorconfig-Datei aus Einstellungen generieren), um automatisch eine .editorconfig-Codeformatdatei auf Grundlage der Einstellungen auf dieser Seite Optionen zu generieren.

Screenshot zum Generieren der Editorconfig-Datei aus den Einstellungen.

Hinzufügen einer EditorConfig-Datei zu einem Projekt

Führen Sie die folgenden Schritte aus, um ihrem Projekt oder Ihrer Projektmappe eine EditorConfig-Datei hinzuzufügen:

  1. Öffnen Sie ein Projekt oder eine Projektmappe in Visual Studio. Wählen Sie den Knoten „Projektmappe“ oder „Projekt“ aus, je nachdem, ob Ihre EditorConfig-Einstellungen für alle Projekte in der Projektmappe oder nur für ein Projekt gelten sollen. Sie können auch einen Ordner in Ihrem Projekt oder Ihrer Projektmappe auswählen, um die .editorconfig-Datei hinzuzufügen.

  2. Wählen Sie im Menü Project>Add New Item, oder drücken Sie Strg+Umschalt+A.

    Das Dialogfeld Neues Element hinzufügen wird geöffnet.

  3. Geben Sie im Suchfeld editorconfigein.

    In den Suchergebnissen werden zwei editorconfig File Elementvorlagen angezeigt.

    Screenshot mit EditorConfig-Dateielementvorlagen in Visual Studio.

    Wenn die Elementvorlage nicht angezeigt wird, müssen Sie die Datei manuell hinzufügen, oder Sie können die Intellicode-Version von .editorconfig hinzufügen, und dann für Ihre Sprache anpassen.

  4. Wählen Sie die Vorlage editorconfig-Datei (leer) aus, um eine EditorConfig-Datei hinzuzufügen, die mit den Standard-EditorConfig-Optionen für Leerzeichen, Codestil und Benennungskonventionen ausgefüllt ist. Oder wählen Sie die editorconfig File (.NET) Vorlage aus, um eine EditorConfig-Datei hinzuzufügen, die mit standardmäßigen .NET-Leerzeichen, Codeformat und Namenskonventionenausgefüllt ist.

    Eine neue .editorconfig Datei wird im Projektmappen-Explorer angezeigt und im Editor als neue Registerkarte geöffnet.

    Für .NET stellt Visual Studio eine formatierte Version der Datei wie folgt bereit.

    Screenshot: .editorconfig-Datei im Projektmappen-Explorer und Editor.

  5. Bearbeiten Sie die Datei optional, und speichern Sie sie.

Dateihierarchie und Rangfolge

Wenn Sie einem Ordner in Ihrer Dateihierarchie eine .editorconfig Datei hinzufügen, gelten die zugehörigen Einstellungen für alle anwendbaren Dateien auf dieser Ebene und niedriger. Sie können editorConfig-Einstellungen auch für ein bestimmtes Projekt, eine Codebasis oder einen Teil einer Codebasis außer Kraft setzen, sodass sie andere Konventionen als andere Teile der Codebasis verwendet. Dies kann nützlich sein, wenn Sie Code an einer anderen Stelle integrieren und die Konventionen nicht ändern möchten.

Befolgen Sie die folgenden Richtlinien:

  • Um einige oder alle EditorConfig-Einstellungen außer Kraft zu setzen, fügen Sie eine .editorconfig-Datei auf der Ebene der Dateihierarchie hinzu, auf die diese überschriebenen Einstellungen angewendet werden sollen. Die neuen EditorConfig-Dateieinstellungen gelten für Dateien auf derselben Ebene und Dateien in allen Unterverzeichnissen.

    Screenshot, der die EditorConfig-Hierarchie zeigt.

  • Wenn Sie einige, aber nicht alle Einstellungen außer Kraft setzen möchten, geben Sie nur diese Einstellungen in der .editorconfig Datei an. Es werden nur die Eigenschaften überschrieben, die Sie in der untergeordneten .editorconfig-Datei explizit aufgelistet. Andere Einstellungen von beliebigen .editorconfig Dateien auf höherer Ebene bleiben weiterhin angewendet.

  • Wenn Sie sicherstellen möchten, dass keine Einstellungen von dateien auf höherer Ebene .editorconfig auf diesen Teil der Codebasis angewendet werden, fügen Sie die root=true Eigenschaft der unteren .editorconfig Datei hinzu.

    # top-most EditorConfig file for this level
root = true

EditorConfig-Dateien werden von oben nach unten gelesen. Wenn mehrere Eigenschaften mit demselben Namen vorhanden sind, hat die zuletzt gefundene Eigenschaft mit demselben Namen Vorrang.

Bearbeiten von EditorConfig-Dateien

Visual Studio 2022 stellt einen visuellen Editor für EditorConfig-Dateien bereit.

Nachdem Sie die EditorConfig-Datei bearbeitet haben, müssen Sie die Codedateien neu laden, damit die neuen Einstellungen wirksam werden.

Beispiel

Das folgende Beispiel zeigt den Einrückungsstatus eines C#-Codefragments vor und nach dem Hinzufügen einer EditorConfig-Datei zum Projekt:

  1. Legen Sie im Dialogfeld Extras>Optionen die Einstellungen Texteditor>C#>Tabulatoren für den Visual Studio-Texteditor so fest, dass vier Leerzeichen erzeugt werden, wenn Sie die Taste Tabulator drücken.

    Screenshot: Einstellung der TAB-Taste für den Text-Editor.

  2. Wie erwartet erfolgt der Einzug beim Drücken der TAB-Taste in der nächsten Zeile durch das Hinzufügen von vier Leerzeichen.

    Screenshot: Tab-Taste zeigt, die Leerzeichen im Code hinzufügt.

  3. Verwenden Sie EditorConfig, um die Einstellung für Tabs so anzupassen, dass Tabs verwendet werden.

    Wählen Sie Tabs verwenden in der EditorConfig-Datei aus.

    Screenshot: Konfigurieren der Verwendung von Tabs für die TAB-Taste.

  4. Wenn Sie die TAB-Taste drücken, werden jetzt Tabstoppzeichen anstelle von Leerzeichen angezeigt.

    Screenshot: Hinzufügen von Tabstoppzeichen im Code mit der TAB-Taste.

Fehlerbehebung bei EditorConfig-Einstellungen

Wenn eine EditorConfig-Datei an einer beliebigen Stelle in der Verzeichnisstruktur am oder über dem Speicherort Des Projekts vorhanden ist, wendet Visual Studio die Editoreinstellungen in dieser Datei auf Ihren Editor an. In diesem Fall wird möglicherweise die folgende Meldung in der Statusleiste angezeigt:

User preferences for this file type are overridden by this project's coding conventions.

Dies bedeutet, dass, wenn editor-Einstellungen in Tools>Optionen>Text-Editor- (z. B. Einzugsgröße und Formatvorlage, Registerkartengröße oder Codierungskonventionen) in einer EditorConfig-Datei unter oder oberhalb des Projekts in der Verzeichnisstruktur angegeben werden, die Konventionen in der EditorConfig-Datei überschreiben die Einstellungen in Text-Editor-.

Führen Sie die folgenden Schritte aus, um EditorConfig-Probleme zu beheben:

  1. Um die EditorConfig-Unterstützung für Visual Studio zu deaktivieren, deaktivieren Sie die Option Follow project coding conventions in Tools>Options>Text Editor.

    Screenshot, der die Einstellung für das Befolgen von Projektkodierungskonventionen zeigt.

  2. Um alle EditorConfig-Dateien in den übergeordneten Verzeichnissen Ihres Projekts zu finden, öffnen Sie eine Eingabeaufforderung, und führen Sie den folgenden Befehl aus dem Stamm des Datenträgers aus, der Ihr Projekt enthält.

    dir .editorconfig /s

  3. Um den Umfang Ihrer EditorConfig-Konventionen zu steuern, legen Sie die root=true-Eigenschaft in der .editorconfig Datei im Stammverzeichnis Ihres Repositorys oder im Verzeichnis fest, in dem sich Ihr Projekt befindet.

    Visual Studio sucht nach einer Datei mit dem Namen .editorconfig im Verzeichnis der geöffneten Datei und in jedem übergeordneten Verzeichnis. Die Suche endet, wenn sie den Stammdateipfad erreicht oder eine .editorconfig Datei mit root=true gefunden wird.

Verwandte Inhalte

  • Last updated on