CA1002: Nie ujawniaj list generycznych
| Właściwości | Wartość |
|---|---|
| Identyfikator reguły | CA1002 |
| Stanowisko | Nie uwidaczniaj list ogólnych |
| Kategoria | Projekt |
| Poprawka powodująca niezgodność lub niezgodność | Kluczowa |
| Domyślnie włączone na platformie .NET 8 | Nie. |
Przyczyna
Typ zawiera zewnętrznie widoczny element członkowski, który jest typem System.Collections.Generic.List<T>List<T> , zwraca typ lub którego podpis zawiera List<T> parametr.
Domyślnie ta reguła analizuje tylko typy widoczne zewnętrznie, ale można to skonfigurować.
Opis reguły
System.Collections.Generic.List<T> to kolekcja ogólna przeznaczona do wydajności, a nie dziedziczenia. List<T> nie zawiera wirtualnych elementów członkowskich, które ułatwiają zmianę zachowania dziedziczonej klasy. Następujące kolekcje ogólne są przeznaczone do dziedziczenia i powinny być uwidocznione zamiast List<T>.
Jak naprawić naruszenia
Aby naprawić naruszenie tej reguły, zmień System.Collections.Generic.List<T> typ na jedną z kolekcji ogólnych przeznaczonych do dziedziczenia.
Kiedy pomijać ostrzeżenia
Nie pomijaj ostrzeżenia z tej reguły, chyba że zestaw, który zgłasza to ostrzeżenie, nie ma być biblioteką wielokrotnego użytku. Na przykład można bezpiecznie pominąć to ostrzeżenie w aplikacji dostosowanej do wydajności, w której korzyści z wydajności zostały uzyskane z używania list ogólnych.
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 CA1002
// The code that's violating the rule is on this line.
#pragma warning restore CA1002
Aby wyłączyć regułę dla pliku, folderu lub projektu, ustaw jego ważność na none w pliku konfiguracji.
[*.{cs,vb}]
dotnet_diagnostic.CA1002.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
Powiązane reguły
CA1005: Unikaj nadużywania parametrów w typach ogólnych
CA1010: Kolekcje powinny implementować interfejs ogólny
CA1000: Nie deklaruj składowych statycznych w typach ogólnych
CA1003: Użyj wystąpień ogólnej procedury obsługi zdarzeń
