CA2017: Niezgodność liczby parametrów

Właściwości	Wartość
Identyfikator reguły	CA2017
Tytuł	Niezgodność liczby parametrów
Kategoria	Niezawodność
Poprawka łamiąca lub nienaruszająca	Niezgodność
Domyślnie włączone na platformie .NET 10	Jako ostrzeżenie
Zastosowane języki	C# i Visual Basic

Przyczyna

Liczba parametrów podanych w szablonie komunikatu rejestrowania jest niezgodna z liczbą nazwanych symboli zastępczych.

Opis reguły

Ta reguła flaguje wywołania rejestratora, które mają niepoprawną liczbę argumentów komunikatów.

Jak naprawić naruszenia

Zrównaj liczbę symboli zastępczych w formacie szablonu z liczbą przekazanych argumentów.

Kiedy pomijać ostrzeżenia

Nie pomijaj ostrzeżeń dla tej reguły.

Example

W poniższym przykładzie przedstawiono metody naruszające ca2017 i metody spełniające regułę.

public class LoggingExample
{
    private readonly ILogger<LoggingExample> _logger;

    public LoggingExample(ILogger<LoggingExample> logger)
    {
        _logger = logger;
    }

    public void ExampleMethod()
    {
        string name = "Alice";
        int age = 30;

        // Violates CA2017: Too few arguments for placeholders.
        _logger.LogInformation("User {Name} is {Age} years old and lives in {City}", name, age);

        // Violates CA2017: Too many arguments for placeholders.
        _logger.LogError("Error occurred: {Message}", "Something went wrong", "Extra argument");

        // Correct usage: Matching number of placeholders and arguments.
        _logger.LogInformation("User {Name} is {Age} years old", name, age);
    }
}

Imports Microsoft.Extensions.Logging

Public Class LoggingExample

    Private ReadOnly _logger As ILogger(Of LoggingExample)

    Public Sub New(logger As ILogger(Of LoggingExample))
        _logger = logger
    End Sub

    Public Sub ExampleMethod()
        Dim name As String = "Alice"
        Dim age As Integer = 30

        ' Violates CA2017: Too few arguments for placeholders.
        _logger.LogInformation("User {Name} is {Age} years old and lives in {City}", name, age)

        ' Violates CA2017: Too many arguments for placeholders.
        _logger.LogError("Error occurred: {Message}", "Something went wrong", "Extra argument")

        ' Correct usage: Matching number of placeholders and arguments.
        _logger.LogInformation("User {Name} is {Age} years old", name, age)
    End Sub

End Class

Zobacz też

• Reguły niezawodności