Compartilhar via


lnt-naming-convention

Certifique-se de que a convenção de nomenclatura dos símbolos esteja alinhada com seu estilo de codificação, conforme especificado no arquivo .editorconfig do projeto.

Para habilitar esse recurso, adicione um arquivo .editorconfig no mesmo diretório que o arquivo do projeto. O .editorconfig especifica as convenções de nomenclatura dos símbolos em seu projeto. Por exemplo, as convenções de nomenclatura para projetos do Unreal Engine são especificadas em um .editorconfig no GitHub.

Uma vez que você deve ter o arquivo .editorconfig no seu projeto, ative a verificação lnt-naming-convention com a configuração Convenção de Nomenclatura nas opções de estilo do código C/C++. Para obter informações sobre como alterar essa configuração, consulte Configurar the linter.

Exemplo

Suponha que você tenha um arquivo .editorconfig que contenha:

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

O linter sinaliza o código a seguir porque ele não é prefixado com 'b' e porque não é um caso Pascal, conforme especificado no arquivo .editorconfig:

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

Como corrigir o problema

Altere a nomenclatura para corresponder ao estilo especificado no .editorconfig:

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

O editor pode fazer a alteração para você. Posicione o cursor sobre o símbolo sinalizado. Escolha Mostrar potenciais correções e, em seguida, Aplicar convenção de nomenclatura:

Screenshot of the IDE suggesting applying naming convention.

O editor de código mostra bool myFlag = true. Com o cursor nessa linha de código, **Mostrar correções potenciais** apareceu e foi escolhido. Agora, **Aplicar convenção de nomenclatura** está visível e mostra bool my Flag = true em vermelho e a alteração sugerida, bool b My Flag, em verde. Agora você pode escolher **Aplicar convenção de nomenclatura** para alterar o código sinalizado para bool b My Flag = true.

Comentários

Introduzida no Visual Studio 2022 17.7, a verificação do linter lnt-naming-convention garante que as convenções de nomenclatura estejam alinhadas com as especificadas no arquivo .editorconfig. Você pode aplicar essa verificação a qualquer projeto que tenha um arquivo .editorconfig. Você também pode personalizar o arquivo .editorconfig de acordo com o estilo de codificação do seu projeto.

Confira também

Criar configurações do editor portátil e personalizado com o EditorConfig
Visão geral do linter de código do IntelliSense para C++