Bagikan melalui

CA1720: Pengidentifikasi tidak boleh berisi nama jenis

  • Artikel
Properti Nilai
ID Aturan CA1720
Judul Pengidentifikasi tidak boleh berisi nama jenis
Golongan Penamaan
Perbaikan bersifat disruptif atau non-disruptif Merusak
Diaktifkan secara default di .NET 9 No

Penyebab

Nama parameter dalam anggota berisi nama jenis data.

-atau-

Nama anggota berisi nama jenis data khusus bahasa.

Secara default, aturan ini hanya melihat anggota yang terlihat secara eksternal, tetapi ini dapat dikonfigurasi.

Deskripsi aturan

Nama parameter dan anggota lebih baik digunakan untuk mengomunikasikan arti mereka daripada menggambarkan jenisnya, yang diharapkan disediakan oleh alat pengembangan. Untuk nama anggota, jika nama jenis data harus digunakan, gunakan nama independen bahasa, bukan nama khusus bahasa. Misalnya, alih-alih nama intjenis C# , gunakan nama jenis data independen bahasa, Int32.

Setiap token diskrit atas nama parameter atau anggota diperiksa terhadap nama jenis data khusus bahasa berikut dengan cara yang tidak peka huruf besar/kecil:

  • Bool
  • WChar
  • Int8
  • UInt8
  • Pendek
  • UShort
  • Int
  • UInt
  • Bilangan bulat
  • UInteger
  • Panjang
  • ULong
  • Tidak ditandatangani
  • Ditandatangani
  • Float
  • Float32
  • Float64

Selain itu, nama parameter juga diperiksa terhadap nama jenis data independen bahasa berikut dengan cara yang tidak peka huruf besar/kecil:

  • Objek
  • Boolean
  • Char
  • String
  • SByte
  • Byte
  • UByte
  • Int16
  • UInt16
  • Int32
  • UInt32
  • Int64
  • UInt64
  • IntPtr
  • Ptr
  • Penunjuk
  • UInptr
  • UPtr
  • UPointer
  • Tunggal
  • Laju
  • Decimal
  • Guid

Cara memperbaiki pelanggaran

Jika diaktifkan terhadap parameter:

Ganti pengidentifikasi jenis data dalam nama parameter dengan istilah yang lebih menjelaskan maknanya atau istilah yang lebih umum, seperti 'nilai'.

Jika diaktifkan terhadap anggota:

Ganti pengidentifikasi jenis data khusus bahasa dalam nama anggota dengan istilah yang lebih menjelaskan maknanya, yang setara dengan bahasa independen, atau istilah yang lebih umum, seperti 'nilai'.

Kapan harus menekan peringatan

Sesekali penggunaan parameter berbasis jenis dan nama anggota mungkin sesuai. Namun, untuk pengembangan baru, tidak ada skenario yang diketahui yang terjadi di mana Anda harus menekan peringatan dari aturan ini. Untuk pustaka yang sebelumnya telah dikirim, Anda mungkin harus menekan peringatan dari aturan ini.

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

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

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

Untuk informasi selengkapnya, lihat Cara menyembunyikan peringatan analisis kode.

Mengonfigurasi kode yang akan dianalisis

Gunakan opsi berikut untuk mengonfigurasi bagian mana dari codebase Anda yang akan menjalankan aturan ini.

Anda dapat mengonfigurasi opsi ini hanya untuk aturan ini, untuk semua aturan yang berlaku untuknya, atau untuk semua aturan dalam kategori ini (Penamaan) yang diterapkannya. Untuk informasi selengkapnya, lihat Opsi konfigurasi aturan kualitas kode.

Menyertakan permukaan API tertentu

Anda dapat mengonfigurasi bagian basis kode mana yang akan dijalankan aturan ini, berdasarkan aksesibilitasnya, dengan mengatur opsi api_surface. Misalnya, untuk menentukan bahwa aturan hanya boleh dijalankan pada permukaan API non-publik, tambahkan pasangan kunci-nilai berikut ke file .editorconfig di proyek Anda:

dotnet_code_quality.CAXXXX.api_surface = private, internal

Nota

Ganti bagian XXXXCAXXXX dengan ID aturan yang berlaku.