Поделиться через


lnt-naming-convention

Убедитесь, что соглашение об именовании символов соответствует стилю написания кода, как указано в файле проекта .editorconfig .

Чтобы включить эту функцию, добавьте .editorconfig файл в тот же каталог, что и файл проекта. Определяет .editorconfig соглашения об именовании символов в проекте. Например, соглашения об именовании для проектов Unreal Engine указываются в .editorconfig GitHub.

После получения .editorconfig файла в проекте включите lnt-naming-convention флажок с параметром Соглашения об именовании в параметрах стиля кода C/C++. Сведения об изменении этого параметра см. в разделе "Настройка linter".

Пример

Предположим, что у вас есть .editorconfig файл, содержащий:

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

Linter помечает следующий код, так как он не префиксирован с "b" и потому что он не является регистром Pascal, как указано в .editorconfig файле:

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

Устранение проблемы

Измените именование в соответствии со стилем, указанным в :.editorconfig

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

Редактор может внести изменения для вас. Поместите курсор на помеченный символ. Выберите " Показать потенциальные исправления" , а затем применить соглашение об именовании:

Снимок экрана: интегрированная среда разработки, предлагающая применение соглашения об именовании.

В редакторе кода отображается bool myFlag = true. С помощью курсора в этой строке кода появилась **Показать возможные исправления** и была выбрана. Теперь **Применить соглашение об именовании** отображается и отображается bool my Flag = true в красном и предлагаемом изменении, bool b My Flag, в зеленом цвете. Теперь можно выбрать **Применить соглашение об именовании**, чтобы изменить помеченный код на bool b My Flag = true.

Замечания

В Visual Studio 2022 17.7 lnt-naming-convention проверка linter гарантирует соответствие соглашений об именовании указанным в .editorconfig файле. Эту проверку можно применить к любому проекту с файлом .editorconfig . Вы также можете настроить .editorconfig файл в соответствии со стилем написания кода проекта.

См. также

Создание переносимых настраиваемых параметров редактора с EditorConfig
Обзор анализатора кода IntelliSense для C++