CA1515: Pertimbangkan untuk membuat jenis publik internal
Properti | Nilai |
---|---|
ID Aturan | CA1515 |
Judul | Pertimbangkan untuk membuat jenis publik internal |
Golongan | Kemampu |
Perbaikan bersifat disruptif atau non-disruptif | Non-disruptif |
Diaktifkan secara default di .NET 8 | Tidak |
Penyebab
Jenis di dalam rakitan yang dapat dieksekusi dinyatakan sebagai publik.
Deskripsi aturan
Tidak seperti pustaka kelas, API aplikasi biasanya tidak direferensikan secara publik, sehingga jenis dapat ditandai internal
.
Jenis internal, pada gilirannya, dapat memperoleh manfaat dari berbagai penganalisis kode yang menargetkan API non-publik.
Cara memperbaiki pelanggaran
Tandai jenis sebagai internal
.
Contoh
Cuplikan kode berikut menunjukkan pelanggaran CA1515:
// 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
Cuplikan kode berikut memperbaiki pelanggaran:
// 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
Kapan harus menekan peringatan
Aman untuk menyembunyikan pelanggaran aturan ini jika Anda tidak khawatir tentang pemeliharaan kode Anda.
Menyembunyikan peringatan
Jika Anda hanya ingin menyembunyikan satu pelanggaran, tambahkan arahan praprosedur ke file sumber Anda untuk dinonaktifkan lalu aktifkan kembali aturannya.
#pragma warning disable CA1515
// The code that's violating the rule is on this line.
#pragma warning restore CA1515
Untuk menonaktifkan aturan untuk file, folder, atau proyek, atur tingkat keparahannya ke none
dalam file konfigurasi.
[*.{cs,vb}]
dotnet_diagnostic.CA1515.severity = none
Untuk informasi selengkapnya, lihat Cara menyembunyikan peringatan analisis kode.
Saran dan Komentar
https://aka.ms/ContentUserFeedback.
Segera hadir: Sepanjang tahun 2024 kami akan menghentikan penggunaan GitHub Issues sebagai mekanisme umpan balik untuk konten dan menggantinya dengan sistem umpan balik baru. Untuk mengetahui informasi selengkapnya, lihat:Kirim dan lihat umpan balik untuk