CA1727: Usar PascalCase para espaços reservados nomeados

Causa

Um espaço reservado nomeado usado não ILogger é PascalCase.

Descrição da regra

Um espaço reservado nomeado usado com ILogger deve ser PascalCase, uma convenção de nomenclatura em que a primeira letra de cada palavra composta em um nome é maiúscula. Essa convenção de nomenclatura é recomendada para o registro em log estruturado, em que cada espaço reservado nomeado é usado como 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 um aviso dessa regra.

Suprimir um aviso

Para suprimir apenas uma violação, adicione diretivas de pré-processador ao arquivo de origem a fim de desabilitar e, em seguida, reabilitar 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 em um arquivo, uma pasta ou um projeto, defina a severidade como none no arquivo de configuração.

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

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