CA1058: Typy nie powinny rozszerzać pewnych typów bazowych
| Właściwości | Wartość |
|---|---|
| Identyfikator reguły | CA1058 |
| Tytuł | Typy nie powinny rozszerzać niektórych typów podstawowych |
| Kategoria | Projekt |
| Poprawka powodująca niezgodność lub niezgodność | Kluczowa |
| Domyślnie włączone na platformie .NET 9 | Nie. |
Przyczyna
Typ rozszerza jeden z następujących typów podstawowych:
- System.ApplicationException
- System.Xml.XmlDocument
- System.Collections.CollectionBase
- System.Collections.DictionaryBase
- System.Collections.Queue
- System.Collections.ReadOnlyCollectionBase
- System.Collections.SortedList
- System.Collections.Stack
Domyślnie ta reguła analizuje tylko typy widoczne zewnętrznie, ale można to skonfigurować.
Opis reguły
Wyjątki powinny pochodzić z jednej z System.Exception jego podklas w System przestrzeni nazw.
Nie należy tworzyć podklasy XmlDocument , jeśli chcesz utworzyć widok XML bazowego modelu obiektów lub źródła danych.
Kolekcje inne niż ogólne
Używaj i/lub rozszerzaj kolekcje ogólne zawsze, gdy jest to możliwe. Nie należy rozszerzać kolekcji innych niż ogólne w kodzie, chyba że zostały wysłane wcześniej.
Przykłady nieprawidłowego użycia
public class MyCollection : CollectionBase
{
}
public class MyReadOnlyCollection : ReadOnlyCollectionBase
{
}
Przykłady poprawnego użycia
public class MyCollection : Collection<T>
{
}
public class MyReadOnlyCollection : ReadOnlyCollection<T>
{
}
Jak naprawić naruszenia
Aby naprawić naruszenie tej reguły, należy uzyskać typ z innego typu podstawowego lub kolekcji ogólnej.
Kiedy pomijać ostrzeżenia
Nie pomijaj ostrzeżenia z tej reguły w przypadku naruszeń dotyczących ApplicationExceptionelementu . Można bezpiecznie pominąć ostrzeżenie z tej reguły w przypadku naruszeń dotyczących XmlDocumentelementu . Można bezpiecznie pominąć ostrzeżenie dotyczące kolekcji innej niż ogólna, jeśli kod został wydany wcześniej.
Pomijanie ostrzeżenia
Jeśli chcesz po prostu pominąć pojedyncze naruszenie, dodaj dyrektywy preprocesora do pliku źródłowego, aby wyłączyć, a następnie ponownie włączyć regułę.
#pragma warning disable CA1058
// The code that's violating the rule is on this line.
#pragma warning restore CA1058
Aby wyłączyć regułę dla pliku, folderu lub projektu, ustaw jego ważność na none w pliku konfiguracji.
[*.{cs,vb}]
dotnet_diagnostic.CA1058.severity = none
Aby uzyskać więcej informacji, zobacz Jak pominąć ostrzeżenia dotyczące analizy kodu.
Konfigurowanie kodu do analizowania
Użyj następującej opcji, aby skonfigurować, które części bazy kodu mają być uruchamiane w tej regule.
Tę opcję można skonfigurować tylko dla tej reguły, dla wszystkich reguł, do których ma ona zastosowanie, lub dla wszystkich reguł w tej kategorii (Projekt), których dotyczy. Aby uzyskać więcej informacji, zobacz Opcje konfiguracji reguły jakości kodu.
Uwzględnij określone powierzchnie interfejsu API
Możesz skonfigurować, na których częściach bazy kodu ma być uruchamiana ta reguła, na podstawie ich ułatwień dostępu. Aby na przykład określić, że reguła powinna być uruchamiana tylko na powierzchni niepublicznego interfejsu API, dodaj następującą parę klucz-wartość do pliku editorconfig w projekcie:
dotnet_code_quality.CAXXXX.api_surface = private, internal
