CA1708:識別項名稱不應該只靠大小寫區別
屬性 | 值 |
---|---|
規則識別碼 | CA1708 |
標題 | 識別項名稱不應該只靠大小寫區別 |
類別 | 命名 |
修正程式是中斷或非中斷 | 中斷 |
預設在 .NET 8 中啟用 | No |
原因
當兩個類型、成員、參數或完整命名空間轉換成小寫時,其名稱會相同。
根據預設,此規則只會查看外部可見的類型、成員和命名空間,但這是可設定的。
檔案描述
因為以通用語言執行平台為目標的語言不需要區分大小寫,因此,命名空間、類型、成員和參數的識別項不能只有大小寫的不同。 例如,Visual Basic 是廣泛使用的不區分大小寫的語言。
如何修正違規
以不區分大小寫的方式,選取與其他標識符比較時唯一的名稱。
隱藏警告的時機
請勿隱藏此規則的警告。 連結庫可能無法在 .NET 的所有可用語言中使用。
設定程式代碼以分析
使用下列選項來設定程式代碼基底要執行此規則的部分。
您可以只針對此規則、它套用的所有規則,或針對套用至此類別的所有規則,或針對它套用的所有規則設定此選項。 如需詳細資訊,請參閱 程式代碼品質規則組態選項。
包含特定 API 介面
您可以根據程式代碼基底的存取範圍,設定要執行此規則的部分。 例如,若要指定規則只應該針對非公用 API 介面執行,請將下列機碼/值組新增至 專案中的 .editorconfig 檔案:
dotnet_code_quality.CAXXXX.api_surface = private, internal
違規範例
下列範例示範此規則的違規。
public class Class1
{
protected string someName;
public string SomeName => someName;
}
下列範例示範修正違規的其中一種方式
public class Class1
{
protected string _someName;
public string SomeName => _someName;
}