CA1058:類型不應該擴充特定基底類型
屬性 | 值 |
---|---|
規則識別碼 | CA1058 |
標題 | 類型不應該擴充特定基底類型 |
類別 | 設計 |
修正程式是中斷或非中斷 | 中斷 |
預設在 .NET 8 中啟用 | No |
原因
類型會擴充下列其中一種基底類型:
- System.ApplicationException
- System.Xml.XmlDocument
- System.Collections.CollectionBase
- System.Collections.DictionaryBase
- System.Collections.Queue
- System.Collections.ReadOnlyCollectionBase
- System.Collections.SortedList
- System.Collections.Stack
根據預設,此規則只會查看外部可見的類型,但這是可設定的。
檔案描述
例外狀況應該衍生自 System.Exception 或其命名空間中的 System 其中一個子類別。
如果您想要建立基礎物件模型或數據源的 XML 檢視,請勿建立 的子類別 XmlDocument 。
非泛型集合
盡可能使用和/或擴充泛型集合。 除非您先前隨附非泛型集合,否則請勿在您的程式代碼中擴充非泛型集合。
不正確的使用方式範例
public class MyCollection : CollectionBase
{
}
public class MyReadOnlyCollection : ReadOnlyCollectionBase
{
}
正確使用方式的範例
public class MyCollection : Collection<T>
{
}
public class MyReadOnlyCollection : ReadOnlyCollection<T>
{
}
如何修正違規
若要修正此規則的違規,請從不同的基底類型或泛型集合衍生類型。
隱藏警告的時機
請勿針對有關 ApplicationException的違規隱藏此規則的警告。 隱藏此規則中有關 XmlDocument違規的警告是安全的。 如果先前發行程式代碼,隱藏非泛型集合的相關警告是安全的。
隱藏警告
如果您只想要隱藏單一違規,請將預處理器指示詞新增至原始程式檔以停用,然後重新啟用規則。
#pragma warning disable CA1058
// The code that's violating the rule is on this line.
#pragma warning restore CA1058
若要停用檔案、資料夾或項目的規則,請在組態檔中將其嚴重性設定為 。none
[*.{cs,vb}]
dotnet_diagnostic.CA1058.severity = none
如需詳細資訊,請參閱 如何隱藏程式代碼分析警告。
設定程式代碼以分析
使用下列選項來設定程式代碼基底要執行此規則的部分。
您可以只針對此規則、針對它套用的所有規則,或針對套用至此類別的所有規則,或針對它套用的所有規則,設定此選項。 如需詳細資訊,請參閱 程式代碼品質規則組態選項。
包含特定 API 介面
您可以根據程式代碼基底的存取範圍,設定要執行此規則的部分。 例如,若要指定規則只應該針對非公用 API 介面執行,請將下列機碼/值組新增至 專案中的 .editorconfig 檔案:
dotnet_code_quality.CAXXXX.api_surface = private, internal