CA1727: используйте PascalCase для именованных заполнителей

Свойство	Значение
Идентификатор правила	CA1727
Заголовок	Используйте PascalCase для именованных заполнителей
Категория	Именование
Исправление является критическим или не критическим	Не разрывное
Включен по умолчанию в .NET 10	Нет
Применимые языки	C# и Visual Basic

Причина

Именованный заполнитель, используемый с ILogger, не в стиле PascalCase.

Описание правила

Именованный заполнитель, используемый с ILogger, должен быть в формате PascalCase — это соглашение об именовании, где первая буква каждого составного слова в имени пишется с заглавной буквы. Это соглашение об именовании рекомендуется для структурированного ведения журнала, где каждый именованный заполнитель используется в качестве имени свойства в структурированных данных.

Устранение нарушений

Используйте PascalCase для именованных заполнителей. Например, измените {firstName} на {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);
    }
}

Когда лучше отключить предупреждения

Вы можете безопасно скрыть предупреждения, связанные с этим правилом.

Отключение предупреждений

Если вы просто хотите отключить одно нарушение, добавьте директивы препроцессора в исходный файл, чтобы отключить и повторно включить правило.

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

Чтобы отключить правило для файла, папки или проекта, задайте его серьезность none в файле конфигурации.

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

Дополнительные сведения см. в разделе Практическое руководство. Скрытие предупреждений анализа кода.