CA1721: I nomi delle proprietà non devono corrispondere ai metodi get

  • Articolo
Proprietà valore
ID regola CA1721
Titolo I nomi delle proprietà non devono corrispondere ai metodi get
Categoria Denominazione
Correzione che causa un'interruzione o un'interruzione Interruzione
Abilitato per impostazione predefinita in .NET 8 No

Causa

Il nome di un membro inizia con 'Get' e in caso contrario corrisponde al nome di una proprietà. Ad esempio, un tipo che contiene un metodo denominato 'GetColor' e una proprietà denominata 'Color' causano una violazione della regola. Questa regola non verrà attivata se la proprietà o il metodo è contrassegnato con .ObsoleteAttribute

Per impostazione predefinita, questa regola esamina solo i membri e le proprietà visibili esternamente, ma è configurabile.

Descrizione regola

I metodi "Get" e le proprietà devono avere nomi indicano chiaramente la distinzione tra le funzioni.

Le convenzioni di denominazione forniscono un aspetto comune per le librerie destinate a Common Language Runtime. Questa coerenza riduce il tempo necessario per apprendere una nuova libreria software e aumenta la fiducia dei clienti che la libreria è stata sviluppata da un utente esperto nello sviluppo di codice gestito.

Come correggere le violazioni

Modificare il nome in modo che non corrisponda al nome di un metodo preceduto da 'Get'.

Quando eliminare gli avvisi

Non escludere un avviso da questa regola. Un'eccezione a tale regola è se il metodo "Get" è causato dall'implementazione dell'interfaccia IExtenderProvider .

Eliminare un avviso

Se si vuole eliminare una singola violazione, aggiungere direttive del preprocessore al file di origine per disabilitare e quindi riabilitare la regola.

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

Per disabilitare la regola per un file, una cartella o un progetto, impostarne la gravità none su nel file di configurazione.

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

Per altre informazioni, vedere Come eliminare gli avvisi di analisi del codice.

Configurare il codice da analizzare

Usare l'opzione seguente per configurare le parti della codebase in cui eseguire questa regola.

È possibile configurare questa opzione solo per questa regola, per tutte le regole a cui si applica o per tutte le regole in questa categoria (denominazione) a cui si applica. Per altre informazioni, vedere Opzioni di configurazione delle regole di qualità del codice.

Includere superfici API specifiche

È possibile configurare le parti della codebase in modo da eseguire questa regola in base all'accessibilità. Ad esempio, per specificare che la regola deve essere eseguita solo sulla superficie dell'API non pubblica, aggiungere la coppia chiave-valore seguente a un file con estensione editorconfig nel progetto:

dotnet_code_quality.CAXXXX.api_surface = private, internal

Esempio

L'esempio seguente contiene un metodo e una proprietà che violano questa regola.

public class Test
{
    public DateTime Date
    {
        get { return DateTime.Today; }
    }

    // Violates rule: PropertyNamesShouldNotMatchGetMethods.
    public string GetDate()
    {
        return this.Date.ToString();
    }
}

Imports System

Namespace ca1721

    Public Class Test

        Public ReadOnly Property [Date]() As DateTime
            Get
                Return DateTime.Today
            End Get
        End Property

        ' Violates rule: PropertyNamesShouldNotMatchGetMethods.
        Public Function GetDate() As String
            Return Me.Date.ToString()
        End Function

    End Class

End Namespace