Freigeben über

CA1720: Bezeichner dürfen keine Typbezeichnungen enthalten.

Eigenschaft Wert
Regel-ID CA1720
Titel Bezeichner dürfen keine Typnamen enthalten.
Kategorie Benennung
Fix führt zu Unterbrechungen oder bleibt funktionsfähig Eilmeldung
Standardmäßig in .NET 10 aktiviert Nein
Anwendbare Sprachen C# und Visual Basic

Ursache

Der Name eines Parameters in einem Member enthält einen Datentypnamen.

Oder

Der Name eines Members enthält einen sprachspezifischen Datentypnamen.

Standardmäßig werden mit dieser Regel nur extern sichtbare Member überprüft, aber dies ist konfigurierbar.

Regelbeschreibung

Namen von Parametern und Membern werden besser verwendet, um ihre Bedeutung zu vermitteln, als zur Beschreibung des Typs, der von den Entwicklungstools bereitgestellt werden soll. Wenn ein Datentypname verwendet werden muss, verwenden Sie für Namen von Membern einen sprachunabhängigen Namen anstelle eines sprachspezifischen Namens. Verwenden Sie beispielsweise anstelle des C#-Typnamens int den sprachunabhängigen Datentypnamen Int32.

Jedes diskrete Token im Namen des Parameters oder Members wird ohne Berücksichtigung der Groß- und Kleinschreibung mit den folgenden sprachspezifischen Datentypnamen verglichen:

  • Bool
  • WChar
  • Int8
  • UInt8
  • Kurz
  • UShort
  • Int
  • UInt
  • Integer
  • UInteger
  • Lang
  • ULong
  • Ungesichert
  • Signiert
  • Float
  • Float32
  • Float64

Die Namen eines Parameters werden groß- und kleinschreibungsunabhängig auf Übereinstimmung mit den folgenden sprachunabhängigen Datentypnamen überprüft.

  • Objekt
  • Boolean
  • Char
  • String
  • SByte
  • Byte
  • UByte
  • Int16
  • UInt16
  • Int32
  • UInt32
  • Int64
  • UInt64
  • IntPtr
  • Ptr
  • Zeiger
  • UInptr
  • UPtr
  • UPointer
  • Single
  • Doppel
  • Decimal
  • GUID

So beheben Sie Verstöße

Wenn für einen Parameter ausgelöst:

Ersetzen Sie den Datentypbezeichner im Namen des Parameters durch einen allgemeineren Begriff oder einen Begriff, der seine Bedeutung besser beschreibt (z. B. „Wert“).

Wenn gegen ein Mitglied ausgelöst:

Ersetzen Sie den sprachspezifischen Datentypbezeichner im Namen des Members durch eine sprachunabhängige Entsprechung, einen allgemeinen Begriff oder einen Begriff, der seine Bedeutung (z. B. „Wert“) besser beschreibt.

Example

// This code violates the rule.
public class Short
{
    public int Int32 { get; set; }
    public Guid Guid { get; set; }

    public void Float(int int32) { }
}

Wann sollten Warnungen unterdrückt werden?

Gelegentlich können typbasierte Parameter- und Elementnamen verwendet werden. Bei der neuen Entwicklung treten jedoch keine bekannten Szenarien auf, in denen Sie eine Warnung aus dieser Regel unterdrücken sollten. Bei Bibliotheken, die bereits ausgeliefert wurden, müssen Sie möglicherweise eine Warnung aufgrund dieser Regel unterdrücken.

Unterdrücken einer Warnung

Um nur eine einzelne Verletzung zu unterdrücken, fügen Sie der Quelldatei Präprozessoranweisungen hinzu, um die Regel zu deaktivieren und dann wieder zu aktivieren.

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

Um die Regel für eine Datei, einen Ordner oder ein Projekt zu deaktivieren, legen Sie den Schweregrad auf none in der Konfigurationsdatei fest.

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

Weitere Informationen finden Sie unter Vorgehensweise: Unterdrücken von Codeanalyse-Warnungen.

Konfigurieren des zu analysierenden Codes

Mithilfe der folgenden Option können Sie konfigurieren, für welche Teile Ihrer Codebasis diese Regel ausgeführt werden soll.

Sie können diese Option nur für diese Regel, für alle zutreffenden Regeln oder für alle zutreffenden Regeln in dieser Kategorie (Benennung) konfigurieren. Weitere Informationen finden Sie unter Konfigurationsoptionen für die Codequalitätsregel.

Einschließen bestimmter API-Oberflächen

Sie können konfigurieren, auf welchen Teilen Ihrer Codebasis je nach Barrierefreiheit diese Regel ausgeführt werden soll, indem Sie die Option api_surface festlegen. Sie können beispielsweise festlegen, dass die Regel nur für die nicht öffentliche API-Oberfläche ausgeführt werden soll, indem Sie einer EDITORCONFIG-Datei in Ihrem Projekt das folgende Schlüssel-Wert-Paar hinzufügen:

dotnet_code_quality.CAXXXX.api_surface = private, internal

Hinweis

Ersetzen Sie den XXXX-Teil von CAXXXX durch die ID der anwendbaren Regel.

  • Last updated on