Udostępnij za pośrednictwem


lnt-naming-convention

Upewnij się, że konwencja nazewnictwa symboli jest zgodna ze stylem kodowania, jak określono w pliku projektu .editorconfig .

Aby włączyć tę funkcję, dodaj .editorconfig plik w tym samym katalogu co plik projektu. Parametr .editorconfig określa konwencje nazewnictwa symboli w projekcie. Na przykład konwencje nazewnictwa projektów Unreal Engine są określone w witrynie .editorconfig GitHub.

Po utworzeniu .editorconfig pliku w projekcie włącz lnt-naming-convention zaznaczenie ustawienia Konwencja nazewnictwa w opcjach Styl kodu C/C++. Aby uzyskać informacje o sposobie zmiany tego ustawienia, zobacz Konfigurowanie lintera.

Przykład

Załóżmy, że masz .editorconfig plik zawierający:

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

Linter flaguje następujący kod, ponieważ nie ma prefiksu "b" i dlatego, że nie jest to przypadek Pascal, jak określono w .editorconfig pliku:

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

Jak rozwiązać problem

Zmień nazewnictwo tak, aby było zgodne ze stylem określonym w pliku .editorconfig:

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

Edytor może wprowadzić zmiany. Umieść kursor na oflagowanych symbolach. Wybierz pozycję Pokaż potencjalne poprawki , a następnie pozycję Zastosuj konwencję nazewnictwa:

Zrzut ekranu przedstawiający środowisko IDE sugerujące stosowanie konwencji nazewnictwa.

W edytorze kodu jest wyświetlana wartość logiczna myFlag = true. Po kliknięciu kursora w tym wierszu kodu **Pokaż potencjalne poprawki** pojawił się i został wybrany. Teraz **Zastosuj konwencję nazewnictwa** jest widoczna i jest wyświetlana wartość logiczna my Flaga = true na czerwono i sugerowana zmiana, bool b Moja flaga, w kolorze zielonym. Teraz możesz wybrać pozycję **Zastosuj konwencję nazewnictwa**, aby zmienić oflagowany kod na wartość logiczną b Moja flaga = true.

Uwagi

Wprowadzony w programie Visual Studio 2022 17.7 sprawdzanie lnt-naming-convention linter gwarantuje, że konwencje nazewnictwa są zgodne z tymi określonymi w .editorconfig pliku. To sprawdzenie można zastosować do dowolnego projektu, który ma .editorconfig plik. Możesz również dostosować .editorconfig plik do stylu kodowania projektu.

Zobacz też

Tworzenie przenośnych, niestandardowych ustawień edytora za pomocą wtyczki EditorConfig
Omówienie lintera kodu IntelliSense dla języka C++