CA1716:識別項名稱不應該和關鍵字相符

  • 發行項
屬性 值
規則識別碼 CA1716
標題 識別項名稱不應該和關鍵字相符
類別 命名
修正程式是中斷或非中斷 中斷
預設在 .NET 8 中啟用 No

原因

命名空間、類型或虛擬或介面成員的名稱符合程式設計語言中的保留關鍵字。

根據預設，此規則只會查看外部可見的命名空間、類型和成員，但您可以 設定可見度 和 符號類型 。

檔案描述

命名空間、類型和虛擬和介面成員的識別碼不應符合以 Common Language Runtime 為目標的語言所定義的關鍵字。 根據所使用的語言和關鍵字，編譯器錯誤和模棱兩可使得程式庫難以使用。

此規則會檢查下列語言中的關鍵字：

  • Visual Basic
  • C#
  • C++/CLI

不區分大小寫的比較用於 Visual Basic 關鍵字，而區分大小寫的比較則用於其他語言。

如何修正違規

選取未出現在關鍵字清單中的名稱。

隱藏警告的時機

如果您確定識別碼不會混淆 API 的使用者，而且程式庫可在 .NET 中的所有可用語言中使用，則可以隱藏此規則的警告。

隱藏警告

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

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

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

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

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

設定程式碼以分析

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

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

包含特定 API 介面

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

dotnet_code_quality.CAXXXX.api_surface = private, internal

分析的符號類型

您可以設定此規則將分析的符號種類。 允許的值如下：

  • Namespace
  • NamedType
  • Method
  • Property
  • Event
  • Parameter

以逗號 （ , ） 分隔多個值。 預設值包含上一個清單中的所有符號類型。

dotnet_code_quality.CA1716.analyzed_symbol_kinds = Namespace, NamedType, Method, Property, Event