CA1727: 名前付きプレースホルダーに PascalCase を使用してください

原因

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

詳細については、「コード分析の警告を抑制する方法」を参照してください。