Bagikan melalui

Aturan bahasa dan yang tidak perlu

  • Artikel

Aturan bahasa gaya kode memengaruhi bagaimana berbagai konstruksi bahasa pemrograman .NET, misalnya, pengubah, dan tanda kurung, digunakan.

Kategori ini juga mencakup aturan yang mengidentifikasi bagian dari basis kode yang tidak perlu dan dapat direfaktor atau dihapus. Kehadiran kode yang tidak perlu menunjukkan salah satu dari lebih dari masalah berikut:

  • Keterbacaan: Kode yang tidak perlu menurunkan keterbacaan.
  • Ketahanan: Kode yang tidak lagi digunakan setelah pemfaktoran ulang dan dipertahankan secara tidak perlu.
  • Performa: Komputasi yang tidak perlu yang tidak memiliki efek samping dan menyebabkan overhead performa yang tidak perlu.
  • Fungsionalitas: Masalah fungsional dalam kode yang membuat kode diperlukan berlebihan. Misalnya, IDE0060 menandai parameter yang tidak digunakan di mana metode secara tidak sengaja mengabaikan parameter input.

Aturan bahasa termasuk dalam kategori berikut:

  • Aturan gaya .NET: Aturan yang berlaku untuk C# dan Visual Basic. Nama opsi untuk aturan ini dimulai dengan awalan dotnet_style_.
  • Aturan gaya C#: Aturan yang khusus untuk kode C#. Nama opsi untuk aturan ini dimulai dengan awalan csharp_style_.
  • Aturan gaya Visual Basic: Aturan yang khusus untuk kode Visual Basic. Nama opsi untuk aturan ini dimulai dengan awalan visual_basic_style_.

Format opsi

Banyak aturan bahasa memiliki satu atau beberapa opsi terkait untuk menyesuaikan gaya pilihan. Misalnya, Gunakan pernyataan 'penggunaan' sederhana (IDE0063) memiliki opsi csharp_prefer_simple_using_statement terkait yang memungkinkan Anda menentukan apakah Anda lebih suka using deklarasi atau using pernyataan. Aturan memberlakukan opsi mana pun yang Anda pilih pada tingkat tertentu, misalnya, peringatan atau kesalahan.

Opsi untuk aturan bahasa dapat ditentukan dalam file konfigurasi dengan format berikut:

option_name = value (Visual Studio 2019 dan yang lebih baru)

or

option_name = value:severity

  • Nilai

    Untuk setiap aturan bahasa pemrogram, Anda menentukan nilai yang menentukan apakah atau kapan harus mengutamakan gaya. Banyak aturan menerima nilai true (mengutamakan gaya ini) atau false (tidak mengutamakan gaya ini). Aturan lain menerima nilai seperti when_on_single_line atau never.

  • Tingkat keparahan (opsional di Visual Studio 2019 dan versi yang lebih baru)

    Bagian kedua aturan menentukan tingkat keparahan untuk aturan. Di .NET 9 dan versi yang lebih baru, tingkat keparahan selalu dihormati—yaitu, di dalam ID pengembangan dan selama build baris perintah. Di .NET 8 dan versi yang lebih lama, pengaturan tingkat keparahan ini hanya dihormati di dalam ID pengembangan, seperti Visual Studio, dan bukan selama build.

    Jika Anda menggunakan .NET 8 SDK atau versi yang lebih lama dan Anda ingin tingkat keparahan dihormati pada waktu build, Anda dapat melakukannya dengan salah satu dari dua cara:

    • Atur <AnalysisLevel> atau <AnalysisLevelStyle> properti ke 9.0 atau lebih tinggi, atau ke preview.
    • Atur tingkat keparahan dengan menggunakan sintaks konfigurasi tingkat keparahan berbasis ID aturan untuk penganalisis sebagai gantinya. Sintaks mengambil formulir dotnet_diagnostic.<rule ID>.severity = <severity>, misalnya, dotnet_diagnostic.IDE0040.severity = warning. Untuk informasi selengkapnya, lihat tingkat keparahan.

Tip

Mulai visual Studio 2019, Anda dapat mengonfigurasi aturan gaya kode dari menu bola lampu Tindakan Cepat setelah pelanggaran gaya terjadi.

Indeks aturan

Aturan bahasa dan kode yang tidak perlu dikategorikan lebih lanjut ke dalam subkategori, seperti preferensi tingkat ekspresi, preferensi blok kode, dan preferensi pengubah.

using preferensi direktif

Aturan gaya .NET (C# dan Visual Basic):

Aturan gaya C#:

Preferensi blok kode

Aturan gaya C#:

Anggota-yang mengisi ekspresi

Aturan gaya C#:

Preferensi tingkat ekspresi

Aturan gaya .NET (C# dan Visual Basic):

Aturan gaya C#:

Aturan gaya Visual Basic:

Preferensi bidang

Aturan gaya .NET (C# dan Visual Basic):

Kata kunci bahasa vs. preferensi jenis kerangka kerja

Aturan gaya .NET (C# dan Visual Basic):

Preferensi pengubah

Aturan gaya .NET (C# dan Visual Basic):

Aturan gaya C#:

Preferensi baris baru

  • Perbolehkan beberapa baris kosong (IDE2000)
  • Perbolehkan pernyataan yang disematkan pada baris yang sama (IDE2001)
  • Perbolehkan baris kosong di antara kurung kurawal berturut-turut (IDE2002)
  • Izinkan pernyataan segera setelah blokir (IDE2003)
  • Izinkan baris kosong setelah titik dua dalam penginisialisasi konstruktor (IDE2004)
  • Izinkan baris kosong setelah token dalam ekspresi kondisi (IDE2005)
  • Perbolehkan baris kosong setelah token dalam ekspresi panah (IDE2006)

Preferensi pemeriksaan null

Aturan gaya C#:

Preferensi parameter

Aturan gaya .NET (C# dan Visual Basic):

Preferensi tanda kurung

Aturan gaya .NET (C# dan Visual Basic):

Preferensi pencocokan pola

Aturan gaya C#:

Preferensi supresi

Aturan gaya .NET (C# dan Visual Basic):

This. dan me. preferensi

Aturan gaya .NET (C# dan Visual Basic):

var Preferensi

Aturan gaya C#:

Lihat juga