Bagikan melalui

CA1200: Hindari menggunakan tag cref dengan prefiks

  • Artikel
Properti Nilai
ID Aturan CA1200
Judul Hindari menggunakan tag cref dengan awalan
Golongan Dokumentasi
Perbaikan bersifat disruptif atau non-disruptif Non-disruptif
Diaktifkan secara default di .NET 8 Tidak

Penyebab

Tag cref dalam komentar dokumentasi XML menggunakan awalan.

Deskripsi aturan

Atribut cref dalam tag dokumentasi XML berarti "referensi kode". Atribut ini menentukan bahwa teks bagian dalam dari tag adalah elemen kode, seperti jenis, metode, atau properti. Hindari menggunakan tag cref dengan prefiks, karena mencegah kompilator memverifikasi referensi. Ini juga mencegah integrated development environment (IDE) Visual Studio dari menemukan dan memperbarui referensi simbol ini selama refaktor. Disarankan agar Anda menggunakan sintaks penuh tanpa awalan untuk mereferensikan nama simbol dalam tag cref.

Cara memperbaiki pelanggaran

Untuk memperbaiki pelanggaran aturan ini, hapus awalan cref dari tag. Misalnya, dua cuplikan kode berikut menunjukkan pelanggaran aturan dan cara memperbaikinya:

// Violates CA1200
/// <summary>
/// Type <see cref="T:C" /> contains method <see cref="F:C.F" />
/// </summary>
class C
{
    public void F() { }
}

// Does not violate CA1200
/// <summary>
/// Type <see cref="C" /> contains method <see cref="F" />
/// </summary>
class C
{
    public void F() { }
}

Kapan harus menekan peringatan

Aman untuk menekan peringatan ini jika referensi kode harus menggunakan awalan karena jenis yang direferensikan tidak dapat ditemukan oleh pengompilasi. Misalnya, jika referensi kode mereferensikan atribut khusus dalam kerangka kerja lengkap, tetapi file dikompilasi terhadap kerangka kerja portabel, Anda dapat menekan peringatan 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 CA1200
// The code that's violating the rule is on this line.
#pragma warning restore CA1200

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

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

Untuk informasi selengkapnya, lihat Cara menyembunyikan peringatan analisis kode.

Baca juga