lnt-naming-convention

Stellen Sie sicher, dass die Namenskonvention für Symbole mit Ihrem Programmierstil übereinstimmt, wie er in der .editorconfig-Datei des Projekts angegeben ist.

Um dieses Feature zu aktivieren, fügen Sie zum Verzeichnis, in dem sich Ihre Projektdatei befindet, eine .editorconfig-Datei hinzu. Die .editorconfig gibt die Namenskonventionen für Symbole in Ihrem Projekt an. Beispielsweise werden die Namenskonventionen für Unreal Engine-Projekte in einer .editorconfig in GitHub angegeben.

Nachdem Sie die .editorconfig-Datei in Ihrem Projekt gespeichert haben, aktivieren Sie die lnt-naming-convention-Überprüfung mithilfe der Einstellung Namenskonvention in den C/C++-Codeformatoptionen. Informationen zum Ändern dieser Einstellung finden Sie unter Konfigurieren des Linters.

Beispiel

Angenommen, Sie haben eine .editorconfig-Datei, die Folgendes enthält:

cpp_naming_style.boolean_style.capitalization = pascal_case
cpp_naming_style.boolean_style.required_prefix = b

Der Linter kennzeichnet den folgenden Code, da das Präfix „b“ fehlt und er kein „Pascal case“ ist, wie in der .editorconfig-Datei angegeben:

void example()
{
    bool myFlag = true; // flagged because it doesn't follow the naming convention specified in the .editorconfig
}

So beheben Sie das Problem

Ändern Sie die Benennung so, dass sie mit dem in der .editorconfig-Datei angegebenen Stil übereinstimmt:

void example()
{ 
    bool bMyFlag = true; // fixed to follow the code style specified in the .editorconfig
} 

Der Editor kann diese Änderung für Sie vornehmen. Platzieren Sie den Cursor auf das gekennzeichnete Symbol. Wählen Sie Show potential fixes (Potenzielle Fehlerbehebungen anzeigen) und dann Apply naming convention (Namenskonvention anwenden) aus:

Der Code-Editor zeigt „bool myFlag = true“. Mit dem Cursor in dieser Codezeile wurde **Show potential fixes** angezeigt und ausgewählt. Jetzt ist **Apply naming convention** ist sichtbar und zeigt „bool my Flag = true“ in Rot und die vorgeschlagene Änderung „bool b My Flag“ in Grün an. Sie können jetzt **Apply naming convention** auswählen, um den gekennzeichneten Code in „bool b My Flag = true“ zu ändern.

Hinweise

Diese in Visual Studio 2022 17.7 eingeführte lnt-naming-convention-Linter-Überprüfung stellt sicher, dass die Namenskonventionen mit denen in der Datei .editorconfig angegebenen übereinstimmen. Sie können diese Überprüfung auf jedes Projekt anwenden, das über eine .editorconfig-Datei verfügt. Sie können Ihre .editorconfig-Datei auch an den Programmierstil Ihres Projekts anpassen.

Siehe auch

Erstellen von portablen, benutzerdefinierten Editor-Einstellungen mit „EditorConfig“
IntelliSense-Codelinter für C++: Übersicht