CA1515: Zvažte interní vytváření veřejných typů

Vlastnost	Hodnota
ID pravidla	CA1515
Název	Zvažte interní vytváření veřejných typů.
Kategorie	Udržovatelnost
Oprava způsobující chybu nebo chybu způsobující chybu	Nenarušující
Povoleno ve výchozím nastavení v .NET 10	Ne

Příčina

Typ uvnitř spustitelného sestavení je deklarován jako veřejný.

Popis pravidla

Na rozdíl od knihovny tříd není rozhraní API aplikace obvykle veřejně odkazováno, takže typy lze označit internal.

Interní typy pak můžou těžit z různých analyzátorů kódu, které cílí na neveřejná rozhraní API.

Jak opravit porušení

Označte typ jako internal.

Příklad

Následující fragment kódu ukazuje porušení ca1515:

// Inside a project with <OutputKind>Exe</OutputKind>.
public class Program
{
    public static void Main(string[] args)
    {
    }
}

' Inside a project with <OutputKind>Exe</OutputKind>.
Public Class Program
    Public Shared Sub Main(args As string())
    End Sub
End Class

Následující fragment kódu opraví porušení zásad:

// Inside a project with <OutputKind>Exe</OutputKind>.
internal class Program
{
    public static void Main(string[] args)
    {
    }
}

' Inside a project with <OutputKind>Exe</OutputKind>.
Friend Class Program
    Public Shared Sub Main(args As string())
    End Sub
End Class

(Další informace o výstupním typu projektu najdete v části Typ výstupu v Návrháři projektů .NET.)

Kdy potlačit upozornění

Pokud vás nezajímá udržovatelnost kódu, je bezpečné potlačit porušení tohoto pravidla.

Potlačení upozornění

Pokud chcete pouze potlačit jedno porušení, přidejte do zdrojového souboru direktivy preprocesoru, abyste pravidlo zakázali a znovu povolili.

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

Pokud chcete pravidlo pro soubor, složku nebo projekt zakázat, nastavte jeho závažnost v none konfiguračním souboru.

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

Další informace naleznete v tématu Jak potlačit upozornění analýzy kódu.

Konfigurace kódu pro analýzu

Můžete nakonfigurovat typy výstupních sestavení , na které se má toto pravidlo použít. Pokud například chcete toto pravidlo použít pouze na kód, který vytváří konzolovou aplikaci nebo dynamicky propojenou knihovnu (tj. ne aplikaci uživatelského rozhraní), přidejte do souboru .editorconfig v projektu následující pár klíč-hodnota:

dotnet_code_quality.CA1515.output_kind = ConsoleApplication, DynamicallyLinkedLibrary

Další informace najdete v tématu output_kind.