Preferensi gaya kode dan pembersihan kode

Preferensi gaya kode memungkinkan Anda mengontrol aspek kode seperti gaya inden, lebar tab, karakter akhir baris, pengodean, dan banyak pilihan pemformatan lainnya. Anda dapat menentukan pengaturan gaya kode dengan dua cara:

• Per basis kode atau per proyek dengan menggunakan file EditorConfig, atau
• Untuk semua kode yang Anda edit di Visual Studio berdasarkan pengaturan untuk halaman Opsi .NET editor teks atau halaman Opsi C/C++.

Anda juga dapat mengonfigurasi Visual Studio untuk menerapkan preferensi gaya kode menggunakan perintah Pembersihan Kode dan Format Dokumen .

Untuk .NET, preferensi gaya kode didasarkan pada penganalisis .NET compiler platform (Roslyn). Untuk informasi selengkapnya, lihat Analisis kode menggunakan penganalisis platform kompilator .NET (Roslyn).

Di Visual Studio 2019 versi 16.5 dan yang lebih baru, file seperangkat aturan tidak digunakan lagi demi file EditorConfig untuk konfigurasi gaya kode untuk kode .NET. Untuk informasi selengkapnya, lihat Mengonversi file seperangkat aturan yang ada ke file EditorConfig.

Gaya kode dalam file EditorConfig

Pengaturan gaya kode dapat ditentukan dengan menambahkan file EditorConfig ke proyek Anda. File EditorConfig dikaitkan dengan basis kode daripada akun personalisasi Visual Studio. Pengaturan dalam file EditorConfig lebih diutamakan daripada gaya kode yang ditentukan dalam kotak dialog opsi . Gunakan file EditorConfig saat Anda ingin menerapkan gaya pengodean untuk semua kontributor ke repositori atau proyek Anda. Mereka sangat berguna untuk memastikan konsistensi dalam lingkungan pemrograman tim.

Untuk menambahkan file EditorConfig, lihat Menambahkan dan menghapus file EditorConfig.

Untuk informasi referensi tentang pengaturan gaya kode .NET, lihat Pengaturan gaya kode.

Gaya kode C/C++ dalam kotak dialog Opsi

Anda dapat menentukan banyak opsi pemformatan kode individual, seperti indentasi dan posisi kurung kurawal. Untuk melakukannya, bukaOpsi>Alat>Editor> TeksC/C++>Pemformatan> Kode (atau ketik Ctrl + Q dan cari "Pemformatan"). Atau, Anda dapat menentukan salah satu gaya ClangFormat (atau gaya ClangFormat kustom Anda sendiri).

Untuk informasi selengkapnya tentang semua opsi pemformatan, lihat Opsi, Editor Teks, C/C++, Pemformatan.

Gaya kode .NET dalam kotak dialog Opsi

Preferensi gaya kode dapat diatur untuk semua proyek C# dan Visual Basic Anda dengan membuka kotak dialog Opsi dari menu Alat. Dalam kotak dialog Opsi , pilih Editor> Teks [C# atau Visual Basic] >Gaya Kode.

• Untuk gaya pemformatan, pilih opsi di bawah Pemformatan.
• Untuk preferensi gaya kode yang terkait dengan tindakan cepat dan aturan gaya kode IDE, pilih opsi di bawah Umum atau Penamaan.

Setiap item dalam daftar memperlihatkan pratinjau preferensi saat Anda memilih opsi:

Opsi yang diatur di jendela ini berlaku untuk akun personalisasi Visual Studio Anda dan tidak terkait dengan proyek atau basis kode tertentu. Selain itu, aturan ini tidak diberlakukan saat build, termasuk dalam build integrasi berkelanjutan (CI). Jika Anda ingin mengaitkan preferensi gaya kode dengan proyek Anda dan menerapkan gaya selama build, tentukan preferensi dalam file EditorConfig yang terkait dengan proyek.

Preferensi dan tingkat keparahan

Untuk setiap pengaturan gaya kode pada halaman opsi Umum dan Penamaan , Anda dapat mengatur nilai Preferensi dan Tingkat Keparahan menggunakan menu drop-down di setiap baris. Tingkat keparahan dapat diatur ke Hanya Pemfaktoran Ulang, Saran, Peringatan, atau Kesalahan.

• Preferensi gaya kode di halaman opsi Umum dan Penamaan menentukan Tindakan Cepat untuk gaya kode. Tindakan Cepat ikon bola lampu, ikon bola lampu kesalahan , atau ikon obeng muncul ketika gaya yang tidak diinginkan digunakan. Anda bisa memilih opsi di daftar Tindakan Cepat untuk menulis ulang kode secara otomatis mengikuti gaya yang disukai.
• Jika Anda ingin pelanggaran hanya muncul sebagai Tindakan Cepat dan juga dikecualikan dari pembersihan kode, atur Tingkat Keparahan ke Pemfaktoran Ulang Saja.
• Jika Anda ingin pelanggaran muncul di jendela Daftar Kesalahan serta Tindakan Cepat, dan disertakan dalam pembersihan kode, atur Tingkat Keparahan ke Saran, Peringatan, atau Kesalahan. Pelanggaran muncul sebagai saran (pesan), peringatan, atau kesalahan saat Anda mengatur output di jendela Daftar Kesalahan ke Build + IntelliSense. Mereka dikecualikan dari output Build saja.

Pengaturan dalam file EditorConfig lebih diutamakan daripada gaya kode yang diatur di halaman ini.

Menerapkan gaya kode dalam proses build

Mulai dari Visual Studio 2019 versi 16.8, yang mencakup .NET 5.0 RC2 SDK, Anda dapat menegakkan konvensi pengkodean .NET pada build untuk semua proyek .NET. Pada waktu build, pelanggaran gaya kode .NET akan muncul sebagai peringatan atau kesalahan dengan awalan "IDE". Ini memungkinkan Anda memberlakukan gaya kode yang konsisten secara ketat di basis kode Anda.

Menerapkan gaya kode

Saat Anda mengubah gaya kode di halaman Opsi atau menambahkan file EditorConfig ke proyek Anda di Visual Studio, hanya baris kode baru yang diformat berdasarkan pengaturan baru. Pemformatan kode yang ada tidak diubah kecuali Anda menjalankan salah satu perintah berikut:

• Pembersihan Kode.

  Pilih Pembersihan Kode di editor Visual Studio, atau tekan Ctrl+K, Ctrl+E. Perintah ini berlaku untuk pengaturan spasi putih, seperti gaya inden, dan pengaturan gaya kode yang dipilih, seperti preferensi tanda kurung.

• Format Dokumen

  Pilih Edit>Format Dokumen Lanjutan>, atau tekan Ctrl+K, Ctrl+D di profil default. Perintah ini hanya berlaku untuk pengaturan spasi putih, seperti gaya inden.

Terapkan gaya kode dengan memanfaatkan fitur pembersihan kode

Untuk menerapkan gaya kode dari file EditorConfig atau dari halaman opsi Gaya Kode , gunakan tombol Pembersihan Kode di bagian bawah editor (keyboard: Ctrl+K, Ctrl+E). Jika ada file EditorConfig untuk proyek, itu adalah pengaturan yang diutamakan.

Ujung

Aturan .NET yang dikonfigurasi dengan tingkat keparahan Pemfaktoran Ulang Saja tidak berpartisipasi dalam pembersihan kode tetapi dapat diterapkan secara individual melalui menu Tindakan Cepat dan Pemfaktoran Ulang .

Untuk menerapkan gaya kode:

1. Pertama, konfigurasikan gaya kode mana yang ingin Anda terapkan (dalam salah satu dari dua profil) dalam kotak dialog Konfigurasikan Pembersihan Kode. Untuk membuka kotak dialog ini, klik panah perluas di samping ikon sapu pembersihan kode lalu pilih Konfigurasikan Pembersihan Kode. Atau, gunakan menu Analisis>Pembersihan Kode .

   

   Untuk pemetaan perbaikan pembersihan kode .NET ke aturan gaya kode .NET, lihat pengaturan pembersihan kode .NET.

   Opsi C/C++ menyertakan C++ dalam nama fixer.

2. Setelah Anda mengonfigurasi pembersihan kode, gunakan salah satu metode berikut untuk menjalankan pembersihan kode:

   • Klik ikon sapu atau tekan Ctrl+K, Ctrl+E.

     

   • Untuk menjalankan pembersihan kode di seluruh proyek atau solusi Anda, klik kanan nama proyek atau solusi di Penjelajah Solusi, pilih Analisis dan Pembersihan Kode, lalu pilih Jalankan Pembersihan Kode.

     

3. (Opsional) Jika Anda ingin pengaturan gaya kode diterapkan setiap kali Anda menyimpan file, buka Opsi>Pembersihan Kode> Teks dan pilih Jalankan profil Pembersihan Kode saat disimpan.

Pengaturan pembersihan kode .NET

Sebagian besar pengaturan pembersihan kode dipetakan ke satu atau beberapa gaya kode .NET yang didukung di EditorConfig. Misalnya yang memperlihatkan efek pengaturan, gunakan tautan dalam tabel berikut.

Pengaturan	ID aturan atau opsi gaya
Menghapus Impor atau penggunaan yang tidak perlu	IDE0005
Mengurutkan impor atau penggunaan	dotnet_sort_system_directives_firstdotnet_separate_import_directive_groups
Menerapkan preferensi header file	file_header_template
Menghapus variabel yang tidak digunakan	CS0219
Menerapkan preferensi pembuatan objek	preferensi_gaya_visual_basic_penyederhanaan_pembuatan_objek
Menerapkan preferensi IsNot	Preferensi gaya Visual Basic untuk ekspresi IsNot
Tambahkan kualifikasi 'ini' atau 'Saya'	IDE0003-IDE0009
Menambahkan pengubah aksesibilitas	dotnet_style_require_accessibility_modifiers
Pengubah pesanan	IDE0036
Jadikan bidang hanya-baca	dotnet_style_readonly_field
Menghapus cast yang tidak perlu	IDE0004
Menerapkan parameter inisialisasi objek/koleksi)	dotnet_style_object_initializer
Menerapkan menggunakan preferensi penempatan direktif	penempatan_direktif_penggunaan_csharp
Menerapkan preferensi tanda kurung	IDE0047-IDE0048
Menerapkan preferensi nilai yang tidak digunakan	IDE0058
Menerapkan preferensi jenis bahasa/kerangka kerja	IDE0049
Menghapus supresi yang tidak digunakan	dotnet_remove_unnecessary_suppression_exclusions
Menerapkan preferensi ekspresi boolean yang disederhanakan	dotnet_style_prefer_simplified_boolean_expressions
Menerapkan preferensi interpolasi string	dotnet_style_prefer_simplified_interpolation
Menghapus parameter yang tidak digunakan	dotnet_code_quality_unused_parameters (parameter yang tidak dipakai)
Menerapkan preferensi properti otomatis	dotnet_style_prefer_auto_properties (preferensi gaya otomatis properti di dotnet)
Menerapkan preferensi penetapan gabungan	dotnet_style_prefer_compound_assignment
Menerapkan preferensi ekspresi penggabungan	dotnet_style_coalesce_expression
Menerapkan preferensi ekspresi kondisional	dotnet_style_prefer_conditional_expression_over_assignmentdotnet_style_prefer_conditional_expression_over_return
Menerapkan preferensi nama tuple	dotnet_style_explicit_tuple_namesdotnet_style_prefer_inferred_tuple_names
Menerapkan preferensi nama anggota tipe anonim yang disimpulkan	dotnet_style_prefer_inferred_anonymous_type_member_names
Menerapkan preferensi pemeriksaan null	dotnet_style_prefer_is_null_check_over_reference_equality_method
Menerapkan preferensi penyebaran null	dotnet_style_null_propagation
Menerapkan preferensi 'var'	IDE0007-IDE0008
Menambahkan kurung kurawal wajib untuk pernyataan kontrol baris tunggal	csharp_prefer_braces
Menerapkan preferensi isi ekspresi/blok	anggota bertubuh ekspresi
Menerapkan preferensi variabel 'out' sebaris	gaya_csharp deklarasi_variabel_segaris
Menerapkan preferensi pencocokan pola	preferensi pencocokan pola
Menerapkan preferensi panggilan delegasi kondisional	pemanggilan_delegasi_kondisional_bergaya_C#
Menerapkan preferensi fungsi lokal statis	csharp_prefer_static_local_function
Menerapkan preferensi dekonstruksi	gaya_csharp_deklarasi_variabel_didekonstruksi
Menerapkan pengaturan bawaan(T)	csharp_prefer_simple_default_expression (preferensi csharp untuk ekspresi default sederhana)
Menerapkan preferensi new()	gaya_csharp_penciptaan_objek_implisit_ketika_tipe_sudah_jelas
Menerapkan preferensi rentang	csharp_gaya_mengutamakan_operator_jangkauan
Menerapkan preferensi fungsi lokal dibandingkan dengan fungsi anonim	gaya_pola_csharp_lokal_daripada_fungsi_anonim
Menerapkan preferensi parameter null	Preferensi pemeriksaan null
Menerapkan menggunakan preferensi pernyataan	csharp_prefer_sederhana_pemakaian_pernyataan
Menerapkan preferensi penggunaan ekspresi 'throw'	csharp_style_throw_expression

Konten terkait

• Tindakan Cepat
• pengaturan konvensi pengkodian .NET untuk EditorConfig