CA2252: Memilih untuk mempratinjau fitur sebelum menggunakannya

Properti Nilai
ID Aturan CA2252
Judul Ikut serta untuk mempratinjau fitur sebelum menggunakannya
Kategori Penggunaan
Perbaikan bersifat merusak atau tidak merusak Tidak terputus
Diaktifkan secara default di .NET 10 Sebagai kesalahan
Bahasa yang berlaku C# dan Visual Basic

Penyebab

Klien menggunakan API pratinjau atau tipe dalam rakitan mereka tanpa secara eksplisit memilih baik secara lokal atau di tingkat modul atau rakitan.

Deskripsi aturan

Saat API atau perakitan yang dilengkapi dengan atribut RequiresPreviewFeaturesAttribute digunakan, aturan ini memeriksa apakah situs pemanggil telah memilih untuk menggunakan fitur pratinjau. Situs panggilan telah memilih untuk mempratinjau fitur jika salah satu hal berikut ini berlaku:

  • Berada dalam cakupan anotasi RequiresPreviewFeaturesAttribute.
  • Merupakan bagian dari perakitan atau modul yang telah mengaktifkan fitur pratinjau.

Gambar berikut menunjukkan contoh diagnostik CA2252.

Editor kode dengan peringatan CA2252.

Di sini, Lib adalah jenis pratinjau yang dibuat dalam metode Main. Main itu sendiri tidak dianotasi sebagai metode pratinjau, sehingga diagnostik diproduksi pada dua panggilan konstruktor di dalam Main.

Cara memperbaiki pelanggaran

Ada dua cara untuk memperbaiki pelanggaran:

  • Bawa lokasi pemanggilan dalam cakupan anotasi dengan menganotasi induknya dengan RequiresPreviewFeaturesAttribute. Dalam contoh sebelumnya, APreviewMethod dianotasi dengan atribut RequiresPreviewFeatures, sehingga penganalisis mengabaikan penggunaan jenis pratinjau di dalam APreviewMethod. Dengan demikian, pemanggil APreviewMethod harus melakukan latihan serupa.

  • Anda juga dapat memilih untuk mempratinjau fitur pada tingkat rakitan atau modul. Ini menunjukkan kepada penganalisis bahwa penggunaan tipe pratinjau di assembly diinginkan dan, sebagai konsekuensinya, aturan ini tidak akan menghasilkan kesalahan. Ini adalah cara yang lebih disukai untuk menggunakan dependensi pratinjau. Untuk mengaktifkan fitur pratinjau di dalam seluruh rakitan, atur properti EnablePreviewFeatures dalam file .csproj:

  <PropertyGroup>
    <EnablePreviewFeatures>true</EnablePreviewFeatures>
  </PropertyGroup>

Kapan harus menekan peringatan

Menyembunyikan peringatan dari aturan ini hanya disarankan untuk kasus penggunaan tingkat lanjut di mana diagnostik pada API perlu dinonaktifkan secara eksplisit. Dalam hal ini, Anda harus bersedia mengambil tanggung jawab untuk menandai API pratinjau dengan tepat. Misalnya, pertimbangkan kasus saat tipe yang sudah ada mengimplementasikan antarmuka pratinjau baru. Karena seluruh jenis tidak dapat ditandai sebagai pratinjau (untuk kompatibilitas mundur), diagnostik di sekitar definisi jenis dapat dinonaktifkan secara lokal. Selain itu, Anda perlu menandai implementasi antarmuka pratinjau sebagai pratinjau. Sekarang, tipe yang sudah ada dapat digunakan seperti sebelumnya, tetapi panggilan ke metode antarmuka baru akan menghasilkan diagnostik. System.Private.CoreLib.csproj menggunakan teknik ini untuk mengekspos fitur matematika generik pada jenis numerik seperti Int32, Double, dan Decimal.

Gambar berikut menunjukkan cara menonaktifkan penganalisis CA2252 secara lokal.

CA2252 - Menonaktifkan Diagnostik Fitur Pratinjau

CA2252 - Menandai Implementasi Antarmuka Secara Eksplisit

Catatan

Anda mungkin melihat peringatan positif palsu dari aturan ini jika semua hal berikut ini berlaku:

  • Anda menggunakan Visual Studio 2022 versi 17.5 atau yang lebih baru dengan versi .NET SDK yang lebih lama, yaitu, .NET 6 atau yang lebih lama.
  • Anda menggunakan penganalisis dari .NET 6 SDK atau versi paket penganalisis yang lebih lama, seperti Microsoft.CodeAnalysis.FxCopAnalyzers.

Dalam hal ini, aman untuk mengabaikan peringatan positif palsu. Positif palsu disebabkan oleh perubahan besar dalam kompiler C#. Pertimbangkan untuk menggunakan penganalisis yang lebih baru yang berisi perbaikan untuk peringatan positif palsu. Tingkatkan ke Microsoft.CodeAnalysis.NetAnalyzers versi 7.0.0-preview1.22464.1 atau yang lebih baru atau gunakan penganalisis dari .NET 7 SDK.

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 CA2252
// The code that's violating the rule is on this line.
#pragma warning restore CA2252

Untuk menonaktifkan aturan untuk file, folder, atau proyek, atur tingkat keparahannya ke none dalam file konfigurasi.

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

Untuk menonaktifkan seluruh kategori aturan ini, atur tingkat keparahan untuk kategori ke none dalam file konfigurasi.

[*.{cs,vb}]
dotnet_analyzer_diagnostic.category-Usage.severity = none

Untuk informasi selengkapnya, lihat Cara menyembunyikan peringatan analisis kode.

Lihat juga

  • Last updated on