CA1508: Hindari kode kondisional yang tidak digunakan

Artikel
09/06/2023

Properti	Nilai
ID Aturan	CA1508
Judul	Hindari kode bersyariah mati
Golongan	Kemampu
Perbaikan bersifat disruptif atau non-disruptif	Tidak Melanggar
Diaktifkan secara default di .NET 8	No

Penyebab

Metode memiliki kode kondisional yang selalu mengevaluasi ke true atau false pada saat durasi. Ini mengarah ke kode yang tidak digunakan di cabang false dari kondisi tersebut.

Secara default, aturan ini menganalisis seluruh codebase, tetapi ini dapat dikonfigurasi.

Deskripsi aturan

Metode dapat memiliki kode bersyarat, seperti pernyataan if, ekspresi biner (==, , !=, <), >pemeriksaan null, dll. Misalnya, pertimbangkan kode berikut:

public void M(int i, int j)
{
    if (i != 0)
    {
        return;
    }

    if (j != 0)
    {
        return;
    }

    // Below condition will always evaluate to 'false' as 'i' and 'j' are both '0' here.
    if (i != j)
    {
        // Code in this 'if' branch is dead code.
        // It can either be removed or refactored.
        ...
    }
}

Pengkompilasi C# dan VB melakukan analisis pemeriksaan kondisional yang melibatkan nilai konstanta waktu kompilasi yang selalu mengevaluasi ke true atau false. Penganalisis ini melakukan analisis aliran data variabel non-konstan untuk menentukan pemeriksaan kondisional redundan yang melibatkan nilai non-konstan. Dalam kode sebelumnya, penganalisis menentukan bahwa i dan j keduanya 0 untuk semua jalur kode yang mencapai i != j pemeriksaan. Oleh karena itu, pemeriksaan ini akan selalu dievaluasi pada false waktu proses. Kode di dalam pernyataan if adalah kode mati dan dapat dihapus atau direfaktor. Demikian pula, penganalisis melacak ketiadaan variabel dan melaporkan pemeriksaan null yang berlebihan.

Catatan

Penganalisis ini melakukan analisis aliran data yang mahal dari nilai non-konstan. Ini dapat meningkatkan waktu kompilasi keseluruhan pada basis kode tertentu.

Kapan harus menekan peringatan

Aman untuk menyembunyikan pelanggaran aturan ini jika Anda tidak khawatir tentang pemeliharaan kode Anda. Tidak masalah juga untuk menekan pelanggaran yang diidentifikasi sebagai positif palsu. Ini dimungkinkan di hadapan kode bersamaan yang dapat dijalankan dari beberapa utas.

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

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

[*.{cs,vb}]
dotnet_diagnostic.CA1508.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.

Mengecualikan simbol tertentu
Mengecualikan jenis tertentu dan jenis turunannya

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

Mengecualikan simbol tertentu

Anda dapat mengecualikan simbol tertentu, seperti jenis dan metode, dari analisis. Misalnya, untuk menentukan bahwa aturan tidak boleh berjalan pada kode apa pun dalam jenis bernama MyType, tambahkan pasangan kunci-nilai berikut ke file .editorconfig di proyek Anda:

dotnet_code_quality.CAXXXX.excluded_symbol_names = MyType

Format nama simbol yang diizinkan pada nilai opsi (dipisahkan oleh |):

Nama simbol saja (menyertakan semua simbol dengan nama, terlepas dari jenis atau namespace yang memuatnya).
Nama yang sepenuhnya memenuhi syarat dalam format ID dokumentasi simbol. Setiap nama simbol memerlukan awalan jenis simbol, seperti M: untuk metode, T: untuk jenis, dan N: untuk namespace.
.ctor untuk konstruktor dan .cctor untuk konstruktor statik.

Contoh:

Nilai Opsi	Ringkasan
`dotnet_code_quality.CAXXXX.excluded_symbol_names = MyType`	Mencocokkan semua simbol bernama `MyType`.
`dotnet_code_quality.CAXXXX.excluded_symbol_names = MyType1\|MyType2`	Mencocokkan semua simbol bernama `MyType1` atau `MyType2`.
`dotnet_code_quality.CAXXXX.excluded_symbol_names = M:NS.MyType.MyMethod(ParamType)`	Mencocokkan `MyMethod` metode tertentu dengan tanda tangan yang sepenuhnya memenuhi syarat yang ditentukan.
`dotnet_code_quality.CAXXXX.excluded_symbol_names = M:NS1.MyType1.MyMethod1(ParamType)\|M:NS2.MyType2.MyMethod2(ParamType)`	Mencocokkan `MyMethod1` dan `MyMethod2` metode tertentu dengan masing-masing tanda tangan yang sepenuhnya memenuhi syarat.

Mengecualikan jenis tertentu dan jenis turunannya

Anda dapat mengecualikan jenis tertentu dan jenis turunannya dari analisis. Misalnya, untuk menentukan bahwa aturan tidak boleh dijalankan pada metode apa pun dalam jenis bernama MyType dan jenis turunannya, tambahkan pasangan kunci-nilai berikut ke file .editorconfig di proyek Anda:

dotnet_code_quality.CAXXXX.excluded_type_names_with_derived_types = MyType