CA1727: Pro pojmenované zástupné symboly použijte PascalCase

Vlastnost	Hodnota
ID pravidla	CA1727
Název	Použití PascalCase pro pojmenované zástupné symboly
Kategorie	Pojmenování
Oprava způsobující chybu nebo chybu způsobující chybu	Nenarušující
Povoleno ve výchozím nastavení v .NET 10	No

Příčina

Pojmenovaný zástupný symbol použitý s ILogger není PascalCase.

Popis pravidla

Pojmenovaný zástupný symbol, se ILogger kterým se používá, by měl být PascalCase, konvence pojmenování, kde je první písmeno každého složeného slova v názvu velkým písmenem. Tato konvence vytváření názvů se doporučuje pro strukturované protokolování, kde se každý pojmenovaný zástupný symbol používá jako název vlastnosti ve strukturovaných datech.

Jak opravit porušení

Pro pojmenované zástupné symboly použijte PascalCase. Například změňte {firstName} na {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);
    }
}

Kdy potlačit upozornění

Je bezpečné potlačit upozornění z tohoto pravidla.

Potlačení upozornění

Pokud chcete pouze potlačit jedno porušení, přidejte do zdrojového souboru direktivy preprocesoru, abyste pravidlo zakázali a znovu povolili.

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

Pokud chcete pravidlo pro soubor, složku nebo projekt zakázat, nastavte jeho závažnost v none konfiguračním souboru.

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

Další informace naleznete v tématu Jak potlačit upozornění analýzy kódu.