Bagikan melalui

Opsi konfigurasi aturan kualitas kode

Aturan kualitas kode memiliki opsi konfigurasi tambahan, selain hanya mengonfigurasi tingkat keparahannya. Misalnya, setiap penganalisis kualitas kode dapat dikonfigurasi untuk hanya berlaku pada bagian tertentu dari basis kode Anda. Anda menentukan opsi ini dengan menambahkan pasangan kunci-nilai ke file EditorConfig yang sama tempat Anda menentukan tingkat keparahan aturan dan preferensi editor umum.

Note

Artikel ini tidak menjelaskan secara detail cara mengonfigurasi tingkat keparahan aturan. Opsi .editorconfig untuk mengatur tingkat keparahan aturan memiliki awalan yang berbeda (dotnet_diagnostic) dengan opsi yang dijelaskan di sini (dotnet_code_quality). Selain itu, opsi yang dijelaskan di sini berkaitan dengan aturan kualitas kode saja, sedangkan opsi tingkat keparahan juga berlaku untuk aturan gaya kode. Sebagai referensi cepat, Anda dapat mengonfigurasi tingkat keparahan aturan menggunakan sintaks opsi berikut:

dotnet_diagnostic.<rule ID>.severity = <severity value>

Namun, untuk informasi mendetail tentang cara mengonfigurasi tingkat keparahan aturan, lihat Tingkat keparahan.

Cakupan opsi

Setiap opsi penyempurnaan dapat dikonfigurasi untuk semua aturan, untuk kategori aturan (misalnya, Keamanan atau Desain), atau untuk aturan tertentu.

Semua aturan

Sintaks untuk mengonfigurasi opsi untuk semua aturan adalah sebagai berikut:

Syntax Example
dotnet_code_quality.<OptionName> = <OptionValue> dotnet_code_quality.api_surface = public

Nilai untuk <OptionName> dicantumkan di bagian Opsi.

Kategori aturan

Sintaks untuk mengonfigurasi opsi bagi kategori aturan adalah sebagai berikut:

Syntax Example
Pengaturan konfigurasi: dotnet_code_quality.<RuleCategory>.<OptionName> = OptionValue dotnet_code_quality.Naming.api_surface = public

Tabel berikut mencantumkan nilai yang tersedia untuk <RuleCategory>.

Design
Documentation
Globalization
Interoperability

Maintainability
Naming
Performance
SingleFile

Reliability
Security
Usage

Aturan tertentu

Sintaks untuk mengonfigurasi opsi bagi aturan tertentu adalah sebagai berikut:

Syntax Example
dotnet_code_quality.<RuleId>.<OptionName> = <OptionValue> dotnet_code_quality.CA1040.api_surface = public

Opsi

Bagian ini mencantumkan opsi konfigurasi yang tersedia untuk penganalisis kode. Untuk informasi lebih lanjut, lihat konfigurasi Analyzer .

api_surface

Description Nilai yang diizinkan Nilai standar Aturan yang dapat dikonfigurasi
Bagian dari permukaan API yang akan dianalisis public (berlaku untuk public DAN protected API)
internal atau friend (berlaku untuk internal DAN private protected API)
private (berlaku untuk private API)
all (berlaku untuk semua API)

Pisahkan beberapa nilai dengan koma (,)		 public CA1000CA1002CA1003CA1005CA1008CA1010CA1012CA1021CA1024CA1027CA1028CA1030CA1036CA1040CA1041CA1043CA1044CA1045CA1046CA1047CA1051CA1052CA1054CA1055CA1056CA1058CA1062CA1063CA1068CA1070CA1700CA1707CA1708CA1710CA1711CA1714CA1715CA1716CA1717CA1720CA1721CA1725CA1801CA1802CA1815CA1819CA1822CA1859CA2208CA2217CA2225CA2226CA2231CA2234

exclude_async_void_methods

Description Nilai yang diizinkan Nilai standar Aturan yang dapat dikonfigurasi
Apakah akan mengabaikan metode asinkron yang tidak menampilkan nilai true
false		 false CA2007

Note

Opsi ini dinamai skip_async_void_methods dalam versi yang lebih lama.

exclude_single_letter_type_parameters

Description Nilai yang diizinkan Nilai standar Aturan yang dapat dikonfigurasi
Apakah akan mengecualikan parameter jenis berkarakter tunggal dari aturan, misalnya, S di Collection<S> true
false		 false CA1715

Note

Opsi ini dinamai allow_single_letter_type_parameters dalam versi yang lebih lama.

output_kind

Description Nilai yang diizinkan Nilai standar Aturan yang dapat dikonfigurasi
Menentukan bahwa kode dalam proyek yang menghasilkan jenis assembly ini harus dianalisis Satu atau beberapa bidang dari enumerasi OutputKind

Pisahkan beberapa nilai dengan koma (,)		 Semua jenis output CA1515, CA1516, CA2007

required_modifiers

Description Nilai yang diizinkan Nilai standar Aturan yang dapat dikonfigurasi
Menentukan pengubah yang diperlukan untuk API yang harus dianalisis Satu atau beberapa nilai dari tabel pengubah yang diizinkan di bawah ini

Pisahkan beberapa nilai dengan koma (,)		 Bergantung pada setiap aturan CA1802
Pengubah yang Diizinkan Summary
none Tidak ada persyaratan pengubah
static atau Shared Harus dinyatakan sebagai static (Shared di Visual Basic)
const Harus dinyatakan sebagai const
readonly Harus dinyatakan sebagai readonly
abstract Harus dinyatakan sebagai abstract
virtual Harus dinyatakan sebagai virtual
override Harus dinyatakan sebagai override
sealed Harus dinyatakan sebagai sealed
extern Harus dinyatakan sebagai extern
async Harus dinyatakan sebagai async

exclude_extension_method_this_parameter

Description Nilai yang diizinkan Nilai standar Aturan yang dapat dikonfigurasi
Apakah akan melewati analisis untuk parameter metode ekstensi this true
false		 false CA1062

null_check_validation_methods

Description Nilai yang diizinkan Nilai standar Aturan yang dapat dikonfigurasi
Nama metode validasi pemeriksaan null yang memvalidasi bahwa argumen yang diteruskan ke metode bukanlah null Format nama metode yang diizinkan (dipisahkan oleh |):
- Nama metode saja (termasuk semua metode dengan nama tersebut, tanpa memandang tipe atau namespace yang memuatnya)
- Nama berkualifikasi penuh dalam format ID dokumentasi simbol, dengan opsi awalan M:		 None CA1062

additional_string_formatting_methods

Description Nilai yang diizinkan Nilai standar Aturan yang dapat dikonfigurasi
Nama metode pemformatan string tambahan Format nama metode yang diizinkan (dipisahkan oleh |):
- Nama metode khusus (termasuk semua metode dengan nama, terlepas dari namespace atau jenis yang menampung)
- Nama yang sepenuhnya memenuhi syarat dalam format ID dokumentasi simbol, dengan awalan M: opsional		 None CA2241

excluded_type_names_with_derived_types

Description Nilai yang diizinkan Nilai standar Aturan yang dapat dikonfigurasi
Nama jenis, sehingga jenis dan semua jenis turunannya dikecualikan untuk analisis Format nama simbol yang diizinkan (dipisahkan oleh |):
- Nama jenis saja (termasuk semua jenis yang memiliki nama ini, terlepas dari namespace atau jenis yang mencakup)
- Nama lengkap di dalam format ID dokumentasi simbol, dengan awalan T: yang bersifat opsional		 None CA1001CA1054CA1055CA1056CA1062CA1068CA1303CA1304CA1305CA1508CA2000CA2100CA2301CA2302CA2311CA2312CA2321CA2322CA2327CA2328CA2329CA2330CA3001CA3002CA3003CA3004CA3005CA3006CA3007CA3008CA3009CA3010CA3011CA3012CA5361CA5376CA5377CA5378CA5380CA5381CA5382CA5383CA5384CA5387CA5388CA5389CA5390CA5399CA5400

excluded_symbol_names

Description Nilai yang diizinkan Nilai standar Aturan yang dapat dikonfigurasi
Nama simbol yang dikecualikan untuk analisis Format nama simbol yang diizinkan (dipisahkan oleh |):
- Nama simbol saja (mencakup semua simbol dengan nama tersebut, terlepas dari tipe atau namespace yang mengandung)
- Nama lengkap yang memenuhi kriteria dalam format ID dokumentasi simbol. Setiap nama simbol memerlukan awalan jenis simbol, seperti awalan M: untuk metode, awalan T: untuk jenis, dan awalan N: untuk namespace layanan.
- .ctor untuk konstruktor dan .cctor untuk konstruktor statik		 None CA1001CA1054CA1055CA1056CA1062CA1068CA1303CA1304CA1305CA1508CA2000CA2100CA2301CA2302CA2311CA2312CA2321CA2322CA2327CA2328CA2329CA2330CA3001CA3002CA3003CA3004CA3005CA3006CA3007CA3008CA3009CA3010CA3011CA3012CA5361CA5376CA5377CA5378CA5380CA5381CA5382CA5383CA5384CA5387CA5388CA5389CA5390CA5399CA5400

disallowed_symbol_names

Description Nilai yang diizinkan Nilai standar Aturan yang dapat dikonfigurasi
Nama simbol yang tidak diizinkan dalam konteks analisis Format nama simbol yang diizinkan (dipisahkan oleh |):
- Hanya nama simbol (menyertakan semua simbol dengan nama tersebut, terlepas dari jenis atau namespace yang berisi)
- Nama yang sepenuhnya memenuhi syarat dalam format ID dokumentasi simbol. Setiap nama simbol memerlukan awalan jenis simbol, seperti awalan M: untuk metode, awalan T: untuk jenis, dan awalan N: untuk namespace layanan.
- .ctor untuk konstruktor dan .cctor untuk konstruktor statik		 None CA1031

exclude_ordefault_methods

Description Nilai yang diizinkan Nilai standar Aturan yang dapat dikonfigurasi
Mengecualikan metode FirstOrDefault dan LastOrDefault dari analisis. true atau false false CA1826

ignore_internalsvisibleto

Description Nilai yang diizinkan Nilai standar Aturan yang dapat dikonfigurasi
Termasuk rakitan yang ditandai dengan InternalsVisibleToAttribute dalam analisis. true atau false true CA1812CA1852

try_determine_additional_string_formatting_methods_automatically

Description Nilai yang diizinkan Nilai standar Aturan yang dapat dikonfigurasi
Opsi Boolean untuk mengaktifkan deteksi heuristik metode pemformatan string tambahan.
Metode dianggap sebagai metode pemformatan string jika memiliki string format parameter yang diikuti oleh params object[] parameter.		 true atau false false CA2241

unsafe_DllImportSearchPath_bits

Description Nilai yang diizinkan Nilai standar Aturan yang dapat dikonfigurasi
Konfigurasi nilai DllImportSearchPath mana yang tidak aman untuk analisis Nilai bilangan bulat dari System.Runtime.InteropServices.DllImportSearchPath 770 (Yaitu, AssemblyDirectory | UseDllDirectoryForDependencies | ApplicationDirectory) CA5393

exclude_aspnet_core_mvc_controllerbase

Description Nilai yang diizinkan Nilai standar Aturan yang dapat dikonfigurasi
Mengecualikan ASP.NET Core MVC ControllerBase saat mempertimbangkan CSRF true atau false true CA5391

enum_values_prefix_trigger

Description Nilai yang diizinkan Nilai standar Aturan yang dapat dikonfigurasi
Menentukan ambang batas untuk memicu aturan penamaan nilai enum - AnyEnumValue - Aturan dipicu jika salah satu nilai enum dimulai dengan nama jenis enum.
- AllEnumValues - Aturan dipicu jika semua nilai enum dimulai dengan nama jenis enum.
- Heuristic - Aturan dipicu menggunakan heuristik FxCop default (yaitu, ketika setidaknya 75% dari nilai enum dimulai dengan nama jenis enum).
 Heuristic CA1712

exclude_indirect_base_types

Description Nilai yang diizinkan Nilai standar Aturan yang dapat dikonfigurasi
Mengecualikan jenis dasar tidak langsung true atau false true CA1710

additional_required_suffixes

Description Nilai yang diizinkan Nilai standar Aturan yang dapat dikonfigurasi
Menentukan akhiran tambahan yang diperlukan Daftar nama tipe (dipisahkan oleh |) dengan akhiran yang diperlukan (dipisahkan oleh ->). Format nama tipe yang diizinkan:
- Hanya nama tipe (mencakup semua tipe dengan nama tersebut, terlepas dari tipe atau namespace yang memuatnya).
- Nama yang sepenuhnya memenuhi syarat dalam format ID dokumentasi simbol dengan awalan opsional T: .		 None CA1710

additional_required_generic_interfaces

Description Nilai yang diizinkan Nilai standar Aturan yang dapat dikonfigurasi
Menentukan antarmuka generik tambahan yang diperlukan Daftar nama antarmuka (dipisahkan oleh |) dengan antarmuka generik dengan kualifikasi lengkap yang diperlukan (dipisahkan oleh ->). Format antarmuka yang diizinkan:
- Nama antarmuka saja (mencakup semua antarmuka dengan nama, terlepas dari jenis atau namespace layanan yang berisi).
- Nama yang sepenuhnya memenuhi syarat dalam format ID dokumentasi simbol dengan awalan opsional T: .		 None CA1010

Examples:

Nilai Opsi Summary
dotnet_code_quality.CA1010.additional_required_generic_interfaces = ISomething->System.Collections.Generic.IEnumerable`1 Semua jenis yang menerapkan ISomething diharapkan juga menerapkan System.Collections.Generic.IEnumerable\`1, terlepas dari ruang nama mana pun.
dotnet_code_quality.CA1010.additional_required_generic_interfaces = T:System.Collections.IDictionary->T:System.Collections.Generic.IDictionary`2 Semua tipe yang menerapkan System.Collections.IDictionary diharapkan juga menerapkan System.Collections.Generic.IDictionary`2.

additional_inheritance_excluded_symbol_names

Description Nilai yang diizinkan Nilai standar Aturan yang dapat dikonfigurasi
Menentukan jenis atau namespace yang akan dikecualikan dari pohon hierarki pewarisan Format nama jenis yang diizinkan:
- Jenis atau nama namespace (termasuk semua jenis dengan nama tersebut, terlepas dari jenis atau namespace yang mengandungnya, dan semua jenis yang namespacenya mengandung nama tersebut).
- Tipe atau nama namespace yang diakhiri dengan simbol kartu bebas (termasuk semua tipe yang namanya dimulai dengan nama yang diberikan, terlepas dari tipe atau namespace yang mengandungnya, dan semua tipe yang namespace-nya berisi nama).
- Nama lengkap dalam format ID dokumentasi simbol dengan awalan opsional T: untuk tipe atau N: untuk namespace.
- Nama jenis atau namespace yang sepenuhnya memenuhi syarat dengan awalan opsional T: untuk tipe atau awalan N: untuk namespace, dan diakhiri dengan simbol wildcard (termasuk semua jenis yang nama penuhnya dimulai dengan nama jenis tersebut, atau semua jenis yang nama penuhnya dimulai dengan nama namespace tersebut).		 N:System.* (Nilai ini selalu ditambahkan secara otomatis ke nilai yang disediakan) CA1501

analyzed_symbol_kinds

Description Nilai yang diizinkan Nilai standar Aturan yang dapat dikonfigurasi
Menentukan jenis simbol yang akan dianalisis Satu atau beberapa bidang SymbolKind sebagai daftar yang dipisahkan oleh koma. Namespace, NamedType, Method, Property, Event, Parameter CA1716

use_naming_heuristic

Description Nilai yang diizinkan Nilai standar Aturan yang dapat dikonfigurasi
Mengonfigurasi apakah parameter atau nama properti yang berisi Text, , Messageatau Caption memicu aturan ini true atau false false CA1303

additional_use_results_methods

Description Nilai yang diizinkan Nilai standar Aturan yang dapat dikonfigurasi
Menentukan API kustom tambahan yang hasilnya harus digunakan Nama metode tambahan (dipisahkan oleh |). Format nama metode yang diizinkan:
- Nama metode saja (mencakup semua metode dengan nama, terlepas dari jenis atau namespace yang berisi).
- Nama yang sepenuhnya memenuhi syarat dalam format ID dokumentasi simbol dengan awalan opsional M: .		 None CA1806

allowed_suffixes

Description Nilai yang diizinkan Nilai standar Aturan yang dapat dikonfigurasi
Menentukan akhiran yang diperbolehkan Daftar (dipisahkan oleh |) akhiran yang diizinkan. None CA1711

enable_platform_analyzer_on_pre_net5_target

Description Nilai yang diizinkan Nilai standar Aturan yang dapat dikonfigurasi
Menentukan apakah akan mengaktifkan analisis untuk TFM sebelum .NET 5 true atau false false CA1416

exclude_structs

Description Nilai yang diizinkan Nilai standar Aturan yang dapat dikonfigurasi
Menentukan apakah akan mengecualikan struktur dari analisis true atau false false CA1051

additional_enum_none_names

Description Nilai yang diizinkan Nilai standar Aturan yang dapat dikonfigurasi
Menentukan nama tambahan yang diizinkan untuk bidang enumerasi nilai nol Daftar nama tambahan (dipisahkan oleh |). None CA1008

enumeration_methods

Description Nilai yang diizinkan Nilai standar Aturan yang dapat dikonfigurasi
Menentukan metode kustom tambahan yang menghitung IEnumerable Nama lengkap metode tambahan (dipisahkan oleh |). None CA1851

linq_chain_methods

Description Nilai yang diizinkan Nilai standar Aturan yang dapat dikonfigurasi
Menentukan metode rantai LINQ kustom tambahan (yaitu, metode menerima IEnumerable argumen dan mengembalikan instansi baru IEnumerable) Nama lengkap metode tambahan (dipisahkan oleh |). None CA1851

assume_method_enumerates_parameters

Description Nilai yang diizinkan Nilai standar Aturan yang dapat dikonfigurasi
Menentukan apakah akan mengasumsikan bahwa metode yang dikustomisasi mendata parameternya IEnumerable true atau false false CA1851

Opsi analisis aliran data

Opsi di bagian ini mengonfigurasi aturan analisis aliran data. Opsinya adalah:

Untuk informasi selengkapnya tentang analisis aliran data, lihat Menulis penganalisis berbasis analisis aliran data.

dispose_analysis_kind

Description Nilai yang diizinkan Nilai standar Aturan yang dapat dikonfigurasi
Menentukan jalur mana yang akan dianalisis untuk membuang pelanggaran - AllPaths - Lacak dan laporkan pelanggaran pembuangan yang terlewat di semua jalur (jalur non-pengecualian dan pengecualian). Selain itu, juga menandai penggunaan pola dispose yang tidak direkomendasikan yang dapat menyebabkan potensi kebocoran dispose.
- AllPathsOnlyNotDisposed - Lacak dan laporkan pelanggaran pengelolaan yang terlewat di semua jalur (jalur non-pengecualian dan jalur pengecualian). Jangan menandai penggunaan pola pembuangan yang tidak direkomendasikan yang dapat menyebabkan potensi kebocoran pembuangan.
- NonExceptionPaths - Lacak dan laporkan pelanggaran yang hilang hanya pada jalur program non-pengecualian. Selain itu, juga menandai penggunaan pola pembuangan yang tidak direkomendasikan yang dapat menyebabkan potensi kebocoran sumber daya.
- NonExceptionPathsOnlyNotDisposed - Lacak dan laporkan pelanggaran dispose yang terlewat hanya pada jalur program tanpa pengecualian. Jangan menandai penggunaan pola pembuangan yang tidak direkomendasikan yang dapat menyebabkan potensi kebocoran pembuangan.		 NonExceptionPaths CA2000

dispose_ownership_transfer_at_constructor

Description Nilai yang diizinkan Nilai standar Aturan yang dapat dikonfigurasi
Mengonfigurasi pengalihan kepemilikan dispose untuk argumen yang diteruskan ke pemanggilan konstruktor true atau false false CA2000

dispose_ownership_transfer_at_method_call

Description Nilai yang diizinkan Nilai standar Aturan yang dapat dikonfigurasi
Mengonfigurasi transfer kepemilikan dispose untuk objek sekali pakai yang diteruskan sebagai argumen ke panggilan metode true atau false false CA2000

interprocedural_analysis_kind

Description Nilai yang diizinkan Nilai standar Aturan yang dapat dikonfigurasi
Menentukan apakah akan melakukan analisis interprocedural untuk pemanggilan metode sumber None, NonContextSensitive, ContextSensitive Khusus untuk setiap aturan yang dapat dikonfigurasi CA1062, CA1303, CA1508, CA2000, CA2100, CA2213

max_interprocedural_method_call_chain

Description Nilai yang diizinkan Nilai standar Aturan yang dapat dikonfigurasi
Menentukan batas maksimum panjang rantai pemanggilan metode yang dianalisis dalam analisis aliran data antarmetode Bilangan bulat tidak ditandatangani 3 CA1062, CA1303, CA1508, CA2000, CA2100, CA2213

max_interprocedural_lambda_or_local_function_call_chain

Description Nilai yang diizinkan Nilai standar Aturan yang dapat dikonfigurasi
Menentukan lambda maksimum atau panjang rantai panggilan fungsi lokal untuk menganalisis analisis aliran data antarprosedural Bilangan bulat tidak ditandatangani 3 CA1062, CA1303, CA1508, CA2000, CA2100, CA2213

points_to_analysis_kind

Description Nilai yang diizinkan Nilai standar Aturan yang dapat dikonfigurasi
Menentukan apakah akan melakukan PointsToAnalysis None, PartialWithoutTrackingFieldsAndProperties, Complete Khusus untuk setiap aturan CA1062, CA1303, CA1508, CA2000, CA2100, CA2213

copy_analysis

Description Nilai yang diizinkan Nilai standar Aturan yang dapat dikonfigurasi
Menentukan apakah akan melakukan analisis salinan (melacak nilai dan salinan referensi) true atau false true untuk sebagian besar aturan CA1062, CA1303, CA1508, CA2000, CA2100, CA2213

sufficient_IterationCount_for_weak_KDF_algorithm

Description Nilai yang diizinkan Nilai standar Aturan yang dapat dikonfigurasi
Mengonfigurasi jumlah iterasi yang memadai saat menggunakan algoritma fungsi derivasi kunci (KDF) yang lemah Integer 100000 untuk sebagian besar aturan CA1062, CA1303, CA1508, CA2000, CA2100, CA2213
  • Last updated on