CA1720:識別項名稱不應該包含類型名稱

  • 發行項
屬性 值
規則識別碼 CA1720
標題 識別項名稱不應該包含類型名稱
類別 命名
修正程式是中斷或非中斷 中斷
預設在 .NET 8 中啟用 No

原因

成員中的參數名稱包含數據類型名稱。

-或-

成員的名稱包含語言特定的數據類型名稱。

根據預設，此規則只會查看外部可見的成員，但這是可設定的。

檔案描述

參數和成員的名稱最好用來傳達其意義，而不是描述其類型，而開發工具預期會提供。 針對成員的名稱，如果使用數據類型名稱，請使用與語言無關的名稱，而不是特定語言的名稱。 例如，使用與語言無關的數據類型名稱，而不是 C# 類型名稱intInt32。

參數或成員名稱中的每個離散令牌都會以不區分大小寫的方式，針對下列語言特定數據類型名稱進行檢查：

  • Bool
  • WChar
  • Int8
  • UInt8
  • Short
  • UShort
  • int
  • UInt
  • 整數
  • UInteger
  • Long
  • ULong
  • Unsigned
  • Signed
  • Float
  • Float32
  • Float64

此外，參數的名稱也會以不區分大小寫的方式，針對下列與語言無關的數據類型名稱進行檢查：

  • Object
  • 布林值
  • Char
  • String
  • SByte
  • Byte
  • UByte
  • Int16
  • UInt16
  • Int32
  • UInt32
  • Int64
  • UInt64
  • IntPtr
  • Ptr
  • Pointer
  • UInptr
  • UPtr
  • UPointer
  • Single
  • Double
  • Decimal
  • GUID

如何修正違規

如果針對參數引發：

將參數名稱中的數據類型標識碼取代為更能描述其意義或更泛型的詞彙，例如 'value'。

如果對成員引發：

將成員名稱中的語言特定數據類型標識碼取代為更能描述其意義、與語言無關的對等專案，或更泛型的詞彙，例如『value』。

隱藏警告的時機

偶爾使用以類型為基礎的參數和成員名稱可能是適當的。 不過，針對新的開發，您應該隱藏此規則的警告時，不會發生任何已知的案例。 對於先前出貨的連結庫，您可能必須隱藏此規則的警告。

隱藏警告

如果您只想要隱藏單一違規，請將預處理器指示詞新增至原始程式檔以停用，然後重新啟用規則。

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

若要停用檔案、資料夾或項目的規則，請在組態檔中將其嚴重性設定為 。none

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

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

設定程式代碼以分析

使用下列選項來設定程式代碼基底要執行此規則的部分。

您可以只針對此規則、它套用的所有規則，或針對套用至此類別的所有規則，或針對它套用的所有規則設定此選項。 如需詳細資訊，請參閱 程式代碼品質規則組態選項。

包含特定 API 介面

您可以根據程式代碼基底的存取範圍，設定要執行此規則的部分。 例如，若要指定規則只應該針對非公用 API 介面執行，請將下列機碼/值組新增至 專案中的 .editorconfig 檔案：

dotnet_code_quality.CAXXXX.api_surface = private, internal