CA1515: Fontolja meg a nyilvános típusok belsővé tételét
Tulajdonság | Érték |
---|---|
Szabályazonosító | CA1515 |
Cím | Fontolja meg a nyilvános típusok belsővé tételét |
Kategória | Fenntarthatóság |
A javítás kompatibilitástörő vagy nem törik | Nem törés |
Alapértelmezés szerint engedélyezve a .NET 8-ban | Nem |
Ok
A végrehajtható szerelvényen belüli típus nyilvánosként lesz deklarálva.
Szabály leírása
Az osztálytárakkal ellentétben az alkalmazás API-jára általában nem hivatkoznak nyilvánosan, így a típusok megjelölhetők internal
.
A belső típusok viszont számos olyan kódelemzőt használhatnak, amelyek nem nyilvános API-kat céloznak meg.
Szabálysértések kijavítása
Jelölje meg a típust .internal
Példa
A következő kódrészlet a CA1515 megsértését mutatja be:
// Inside a project with <OutputKind>Exe</OutputKind>
public class Program
{
public static void Main(string[] args)
{
}
}
Public Class Program
Public Shared Sub Main(args As string())
End Sub
End Class
A következő kódrészlet kijavítja a szabálysértést:
// Inside a project with <OutputKind>Exe</OutputKind>
internal class Program
{
public static void Main(string[] args)
{
}
}
Friend Class Program
Public Shared Sub Main(args As string())
End Sub
End Class
Mikor kell letiltani a figyelmeztetéseket?
Ha nem aggódik a kód karbantarthatósága miatt, nyugodtan letilthatja a szabály megsértését.
Figyelmeztetés mellőzése
Ha csak egyetlen szabálysértést szeretne letiltani, adjon hozzá előfeldolgozási irányelveket a forrásfájlhoz a szabály letiltásához és újbóli engedélyezéséhez.
#pragma warning disable CA1515
// The code that's violating the rule is on this line.
#pragma warning restore CA1515
Ha le szeretné tiltani egy fájl, mappa vagy projekt szabályát, állítsa annak súlyosságát none
a konfigurációs fájlban.
[*.{cs,vb}]
dotnet_diagnostic.CA1515.severity = none
További információ: Kódelemzési figyelmeztetések letiltása.