Partilhar via


CA1727: Use PascalCase para espaços reservados com nome

Propriedade valor
ID da regra CA1727
Título Usar PascalCase para espaços reservados com nomes
Categoria Atribuição de nomes
A correção causa interrupção ou não Ininterrupto
Habilitado por padrão no .NET 10 Não
Línguas aplicáveis C# e Visual Basic

Motivo

Um marcador de posição com nome usado com ILogger não está em PascalCase.

Descrição da regra

Um espaço reservado nomeado utilizado com ILogger deve ser PascalCase, uma convenção de nomenclatura onde a primeira letra de cada palavra composta num nome é maiúscula. Essa convenção de nomenclatura é recomendada para registo estruturado, onde cada espaço reservado nomeado é usado como um nome de propriedade nos dados estruturados.

Como corrigir violações

Use PascalCase para espaços reservados nomeados. Por exemplo, altere {firstName} para {FirstName}.

Example

public class UserService
{
    private readonly ILogger<UserService> _logger;

    public UserService(ILogger<UserService> logger)
    {
        _logger = logger;
    }

    public void Create(string firstName, string lastName)
    {
        // This code violates the rule.
        _logger.LogInformation("Creating user {firstName} {lastName}", firstName, lastName);

        // This code satisfies the rule.
        _logger.LogInformation("Creating user {FirstName} {LastName}", firstName, lastName);
    }
}

Quando suprimir avisos

É seguro suprimir uma advertência desta regra.

Suprimir um aviso

Se você quiser apenas suprimir uma única violação, adicione diretivas de pré-processador ao seu arquivo de origem para desativar e, em seguida, reativar a regra.

#pragma warning disable CA1727
// The code that's violating the rule is on this line.
#pragma warning restore CA1727

Para desabilitar a regra de um arquivo, pasta ou projeto, defina sua gravidade como none no arquivo de configuração.

[*.{cs,vb}]
dotnet_diagnostic.CA1727.severity = none

Para obter mais informações, consulte Como suprimir avisos de análise de código.