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

如需詳細資訊，請參閱 如何隱藏程式代碼分析警告。