CA1727: PascalCase gebruiken voor benoemde tijdelijke aanduidingen

Oorzaak

Een benoemde tijdelijke aanduiding waarmee ILogger wordt gebruikt, is geen PascalCase.

Beschrijving van regel

Een benoemde tijdelijke aanduiding die met ILogger wordt gebruikt, moet PascalCase zijn, een naamgevingsconventie waarbij de eerste letter van elk samengesteld woord in een naam met een hoofdletter begint. Deze naamconventie wordt aanbevolen voor gestructureerde logboekregistratie, waarbij elke benoemde tijdelijke aanduiding wordt gebruikt als een eigenschapsnaam in de gestructureerde gegevens.

Hoe schendingen op te lossen

Gebruik PascalCase voor benoemde tijdelijke aanduidingen. Wijzig bijvoorbeeld {firstName} in {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);
    }
}

Wanneer waarschuwingen onderdrukken

Het is veilig om een waarschuwing van deze regel te onderdrukken.

Een waarschuwing onderdrukken

Als u slechts één schending wilt onderdrukken, voegt u preprocessorrichtlijnen toe aan uw bronbestand om de regel uit te schakelen en vervolgens opnieuw in te schakelen.

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

Als u de regel voor een bestand, map of project wilt uitschakelen, stelt u de ernst none ervan in op het configuratiebestand.

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

Zie voor meer informatie Hoe codeanalysewaarschuwingen te onderdrukken.