Kod stili tercihleri ve kod temizleme

Kod stili tercihleri, girinti stili, sekme genişliği, satır sonu karakterleri, kodlama ve diğer birçok biçimlendirme seçeneği gibi kodun özelliklerini denetlemenizi sağlar. Kod stili ayarlarını iki şekilde tanımlayabilirsiniz:

• EditorConfig dosyası kullanarak kod tabanı veya proje başına veya
• Visual Studio'da metin düzenleyicisi .NET Seçenekleri sayfası veya C/C++ Seçenekleri sayfası ayarlarına göre düzenlediğiniz tüm kodlar için.

Visual Studio'yu , Kod Temizleme ve Belgeyi Biçimlendir komutlarını kullanarak kod stili tercihlerini uygulayacak şekilde de yapılandırabilirsiniz.

.NET için, kod stili tercihleri .NET derleyici platformu (Roslyn) çözümleyicilerini temel alır. Daha fazla bilgi için bkz. .NET derleyici platformu (Roslyn) çözümleyicilerini kullanarak kod analizi.

Visual Studio 2019 sürüm 16.5 ve sonraki sürümlerinde kural kümesi dosyaları, .NET kodu için kod stili yapılandırması için EditorConfig dosyalarına göre kullanım dışı bırakılmıştır. Daha fazla bilgi için bkz . Var olan bir kural kümesi dosyasını EditorConfig dosyasına dönüştürme.

EditorConfig dosyalarındaki kod stilleri

Kod stili ayarları, projenize bir EditorConfig dosyası eklenerek belirtilebilir. EditorConfig dosyaları Visual Studio kişiselleştirme hesabı yerine bir kod tabanıyla ilişkilendirilir. EditorConfig dosyasındaki ayarlar, Seçenekleri iletişim kutusunda belirtilen kod stillerine göre önceliklidir. Deponuza veya projenize katkıda bulunan tüm kullanıcılar için kodlama stillerini zorlamak istediğinizde EditorConfig dosyası kullanın. Ekip programlama ortamında tutarlılık sağlamak için özellikle kullanışlıdır.

EditorConfig dosyası eklemek için bkz. EditorConfig dosyaları ekleme ve kaldırma.

.NET kod stili ayarlarıyla ilgili başvuru bilgileri için bkz. Kod stili ayarları.

Seçenekler iletişim kutusundaki C/C++ kod stilleri

Girintileme ve ayraç konumları gibi birçok tek tek kod biçimlendirme seçeneği belirtebilirsiniz.

Araçlar>Seçenekleri bölmesinde Tüm Ayarlar>Dilleri>C/C++>Kod Stili>Biçimlendirme>Genel bölümünü genişletin. Ctrl + Q klavye kısayolunu da kullanabilir ve Biçimlendirme'yi arayabilirsiniz. Alternatif olarak, bir ClangFormat stili veya kendi özel ClangFormat stilinizi belirtebilirsiniz.

Tüm biçimlendirme seçenekleri hakkında daha fazla bilgi için bkz. Seçenekler, Metin Düzenleyicisi, C/C++, Biçimlendirme.

Seçenekler iletişim kutusundaki .NET kod stilleri

Araçlar menüsünden Seçenekler iletişim kutusu açılarak tüm C# ve Visual Basic projeleriniz için kod stili tercihleri ayarlanabilir. Seçenekler iletişim kutusunda Metin Düzenleyicisi> [C# veya Visual Basic] >Kod Stili'ni seçin.

• Biçimlendirme stilleri için Biçimlendirme'nin altındaki seçenekleri belirleyin.
• Hızlı Eylemler ve IDE kod stili kurallarıyla ilişkili kod stili tercihleri için Genel veya Adlandırma altındaki seçenekleri belirleyin.

Listedeki her öğe, seçeneği belirlediğinizde tercihin önizlemesini gösterir:

Bu pencerede ayarlanan seçenekler Visual Studio kişiselleştirme hesabınız için geçerlidir ve belirli bir proje veya kod tabanıyla ilişkili değildir. Derleme zamanında, sürekli tümleştirme (CI) derlemeleri de dahil, bu kurallar zorunlu kılınmaz. Kod stili tercihlerini projenizle ilişkilendirmek ve derleme sırasında stilleri zorunlu kılmak istiyorsanız, tercihleri projeyle ilişkilendirilmiş bir EditorConfig dosyasında belirtin.

Tercih ve önem derecesi

Genel ve Adlandırma seçenekleri sayfasındaki her kod stili ayarı için, her satırdaki açılan menüleri kullanarak Tercih ve Önem Derecesi değerlerini ayarlayabilirsiniz. Önem derecesi Yalnızca Yeniden Düzenleme, Öneri, Uyarıveya Hataolarak ayarlanabilir.

• Genel ve Adlandırma seçenekleri sayfalarındaki kod stili tercihleri, bir kod stili için Hızlı Eylemler'i belirler. Başvurulmayan bir stil kullanıldığında Hızlı Eylemler ampulü , hata ampulü veya tornavida simgesi görüntülenir ve kodu tercih edilen stile otomatik olarak yeniden yazmak için Hızlı Eylemler listesinde bir seçenek belirleyebilirsiniz.
• İhlalin yalnızca Hızlı Eylem olarak görünmesini ve ayrıca kod temizlemenin dışında tutulmasını istiyorsanız Önem Derecesi'niYalnızca Yeniden Düzenleme olarak ayarlayın.
• İhlalin Hata Listesi penceresinde Hızlı Eylemler ile birlikte görünmesini ve kod temizlemeye eklenmesini istiyorsanız Önem Derecesi'niÖneri, Uyarı veya Hata olarak ayarlayın. Hata Listesi penceresindeki çıkışı Derleme + IntelliSense olarak ayarladığınızda ihlaller bir öneri (ileti), uyarı veya hata olarak görünür. Derleme çıkışına yalnızca bunlar dahil edilmez.

EditorConfig dosyasındaki ayarlar, bu sayfalarda ayarlanan kod stillerine göre önceliklidir.

Oluşturma sırasında kod stillerini zorunlu kılma

.NET 5.0 RC2 SDK'sını içeren Visual Studio 2019 sürüm 16.8'den başlayarak, tüm .NET projeleri için derleme üzerinde .NET kodlama kurallarını zorunlu uygulayabilirsiniz. Derleme zamanında .NET kod stili ihlalleri bir "IDE" ön ekiyle uyarı veya hata olarak görünür. Bu, kod tabanınızda tutarlı kod stillerini kesinlikle zorunlu kılmanızı sağlar.

Kod stilleri uygulama

Seçenekler sayfasında bir kod stilini değiştirdiğinizde veya Visual Studio'da projenize EditorConfig dosyası eklediğinizde, yeni ayarlara göre yalnızca yeni kod satırları biçimlendirilir. Aşağıdaki komutlardan birini çalıştırmadığınız sürece mevcut kodun biçimlendirmesi değiştirilmez:

• Kod Temizleme.

  Visual Studio düzenleyicisinde Kod Temizleme'yi seçin veya Ctrl+K, Ctrl+E tuşlarına basın. Bu komut, girinti stili gibi boşluk ayarlarına ve parantez tercihleri gibi seçili kod stili ayarlarına uygulanır.

• Belgeyi Biçimlendir.

  Düzenle>, Gelişmiş>, Belgeyi Biçimlendir'i seçin veya varsayılan profilde Ctrl+ + K, Ctrl+ + D'ye basın. Bu komut yalnızca girinti stili gibi boşluk ayarlarına uygulanır.

Kod temizlemeyi kullanarak kod stilleri uygulama

Bir EditorConfig dosyasından veya Kod Stili seçenekleri sayfasından kod stilleri uygulamak için düzenleyicinin altındaki Kod Temizleme düğmesini kullanın (klavye: Ctrl+K, Ctrl+E). Proje için bir EditorConfig dosyası varsa, dosyadaki ayarlar önceliklidir.

Bahşiş

Yalnızca Yeniden Düzenleme önem derecesiyle yapılandırılmış .NET kuralları kod temizlemeye katılmaz, ancak Hızlı Eylemler ve Yeniden Düzenlemeler menüsü aracılığıyla tek tek uygulanabilir.

Kod stilleri uygulamak için:

1. İlk olarak, Kod Temizlemeyi Yapılandır iletişim kutusunda uygulamak istediğiniz kod stillerini (iki profilden birinde) yapılandırın. Bu iletişim kutusunu açmak için, kod temizleme süpürgesi simgesinin yanındaki genişletici okunu seçin ve ardından Kod Temizlemeyi Yapılandır'ı seçin. Alternatif olarak, Kod Temizlemeyi> menüsünü de kullanabilirsiniz.

   

   .NET kod temizleme düzelticilerini .NET kod stili kurallarına eşlemek için bkz. .NET kod temizleme ayarları.

   C/C++ seçenekleri, düzeltici adına C++ ekler.

2. Kod temizlemeyi yapılandırdıktan sonra, kod temizlemeyi çalıştırmak için aşağıdaki yöntemlerden birini kullanın:

   • Süpürge simgesini seçin veya CtrlK, +E+ basın.

     

   • Projenizin veya çözümünüzün tamamında kod temizlemeyi çalıştırmak için Çözüm Gezgini'nde projeye veya çözüm adına sağ tıklayın, Çözümle ve Kod Temizleme'yi seçin ve ardından Kod Temizlemeyi Çalıştır'ı seçin.

     

3. (İsteğe bağlı) Bir dosyayı her kaydettiğinizde kod stili ayarlarınızın uygulanmasını istiyorsanız , Seçenekler>Metin Düzenleyicisi>Kod Temizleme'ye gidin ve kaydetmede Kod Temizleme profilini çalıştır'ı seçin.

.NET kod temizleme ayarları

Kod temizleme ayarlarının çoğu EditorConfig'de desteklenen bir veya daha fazla .NET kod stiliyle eşleniyor. Ayarların etkilerini gösteren örnekler için aşağıdaki tabloda yer alan bağlantıları kullanın.

Ayar	Kural kimliği veya stil seçeneği
Gereksiz İçeri aktarmaları veya kullanımı kaldırma	IDE0005
İçe aktarmaları veya kullanımları sırala	dotnet_sistem_yönergelerini_öncelikli_sırala dotnet_dışa_aktarım_yönerge_gruplarını_ayır
Dosya üst bilgisi tercihlerini uygulama	dosya_baslik_şablonu
Kullanılmayan değişkenleri kaldırma	cs0219
Nesne oluşturma tercihlerini uygulama	görsel_temel_stil_basitleştirilmiş_nesne_oluşturmayı_tercih_eder
IsNot tercihlerini uygulama	Visual Basic stili "isnot" ifadesini tercih et
'This' veya 'Me' niteliğini ekleyin	IDE0003-IDE0009
Erişilebilirlik değiştiricileri ekleme	dotnet_style_require_accessibility_modifiers (erişilebilirlik değiştiricilerini zorunlu kılma stili)
Sipariş değiştiricileri	IDE0036
Alanı salt okunur yapın	dotnet_style_readonly_field
Gereksiz atamaları kaldırma	IDE0004
Nesne/koleksiyon başlatma parametrelerini uygulama)	dotnet_style_object_initializer
Yönerge yerleştirme tercihlerini kullanarak uygulama	csharp_using_directive_placement
Parantez tercihlerini uygulama	IDE0047-IDE0048
Kullanılmayan değer tercihlerini uygulama	IDE0058
Dil/çerçeve türü tercihlerini uygulama	IDE0049
Kullanılmayan gizlemeleri kaldırma	dotnet_gereksiz_baskılamaları_kaldırma_dışlamaları
Boole ifade tercihlerini basitleştirmeyi uygulama	dotnet_style_prefer_simplified_boolean_expressions
Dize ilişkilendirme tercihlerini uygulama	dotnet_style_prefer_simplified_interpolation
Kullanılmayan parametreleri kaldırma	dotnet_kod_kalitesi_kullanılmayan_parametreler
Otomatik özellik tercihlerini uygulama	dotnet_style_prefer_auto_properties
Bileşik atama tercihlerini uygulama	dotnet_style_prefer_compound_assignment
Birleşim ifadesi tercihlerini uygulama	dotnet_style_coalesce_expression
Koşullu ifade tercihlerini uygulama	dotnet_style_prefer_conditional_expression_over_assignmentdotnet_style_prefer_conditional_expression_over_return
Tuple adı tercihlerini uygulama	dotnet_style_explicit_tuple_namesdotnet_style_prefer_inferred_tuple_names
Çıkarsanan anonim tür üye adları tercihlerini uygulama	dotnet_style_prefer_inferred_anonymous_type_member_names
Null denetim tercihlerini uygulama	dotnet_style_prefer_is_null_check_over_reference_equality_method
Null yayma tercihlerini uygulama	dotnet_style_null_propagation (dotnet tarzı null yayılımı)
'var' tercihlerini uygulama	IDE0007-IDE0008
Tek satırlı denetim deyimleri için gerekli küme parantezlerini ekleyin	csharp_tercih_ayraç_kullanımı
İfade/blok gövdesi tercihlerini uygulama	İfade gövdeli üyeler
Satır içi 'out' değişkenleri tercihlerini uygulama	csharp_stili_satır_içi_değişken_tanımlama
Desen eşleştirme tercihlerini uygulama	Desen eşleştirme tercihleri
Koşullu temsilci arama tercihlerini uygulama	csharp_stili_koşullu_delege_çağrısı
Statik yerel işlev tercihlerini uygulama	csharp_prefer_static_local_function (C# statik yerel fonksiyonları tercih et)
Yıkım tercihlerini uygula	csharp_stili_parçalanmış_değişken_beyanı
Varsayılan(T) tercihlerini uygulama	csharp_basit_varsayılan_ifade_tercih_et
new() tercihlerini uygulama	csharp_stili_türün_açık_olduğu_durumlarda_örtük_nesne_oluşturma
Aralık tercihlerini uygula	csharp_stili_tercih_aralık_operatörü
Anonim işlev tercihleri üzerine yerel kullanım uygulayın	durağan bir fonksiyon yerine yerel desen kullanma
Parametre null tercihlerini uygulama	Null denetimi tercihleri
Kullanım ifadesi tercihlerini uygula	C# basit using deyimi tercih et
Throw ifadesi tercihlerini uygulama	csharp_style_throw_expression

İlgili içerik

• Hızlı İşlemler
• ve için .NET kodlama kuralı ayarları EditorConfig