Mac için Visual Studio'da özel EditorConfig dosyası oluşturma ve düzenleme

Önemli

Mac için Visual Studio 31 Ağustos 2024'te Microsoft'un Modern Yaşam Döngüsü İlkesi. Mac için Visual Studio ile çalışmaya devam edebilirsiniz ancak Mac'te geliştiriciler için VS Code için yeni C# Dev Kit uzantısının önizleme sürümü gibi birkaç seçenek daha vardır.

Destek zaman çizelgeleri ve alternatifleri hakkında daha fazla bilgi edinin.

Mac için Visual Studio'da, kod tabanında çalışan herkes için tutarlı kodlama stilleri uygulamak için projenize veya çözümünüze bir EditorConfig dosyası ekleyebilirsiniz. EditorConfig dosyasında bildirilen ayarlar, genel Mac için Visual Studio metin düzenleyicisi ayarlarından önceliklidir. Projenizde veya kod tabanınızda bir EditorConfig dosyası kullanmak, projeniz için kodlama stilinizi, tercihlerinizi ve uyarılarınızı ayarlamanıza olanak tanır. Dosya kod tabanınızın bir parçası olduğundan, kullandıkları IDE veya kod düzenleyicisinden bağımsız olarak tüm kullanıcıların projenin kodlama uygulamalarına uymasını kolaylaştırır.

EditorConfig dosyaları Visual Studio dahil olmak üzere birçok IDE ve kod düzenleyicisinde desteklenir.

Desteklenen ayarlar

Mac için Visual Studio'daki düzenleyici, EditorConfig özelliklerinin çekirdek kümesini destekler:

  • indent_style
  • indent_size
  • tab_width
  • end_of_line
  • charset
  • trim_trailing_whitespace
  • insert_final_newline
  • root

EditorConfig, C# dilinde kodlama kurallarını da destekler.

Projeye EditorConfig dosyası ekleme

Yeni bir EditorConfig dosyası ekleme

  1. Projenizi Mac için Visual Studio açın. EditorConfig dosyasını eklemek istediğiniz çözümü veya proje düğümünü seçin. Dosyayı çözüm dizinine eklemek çözümdeki tüm projelere .editorconfig ayarlarını uygular.

  2. Düğüme sağ tıklayın ve Yeni Dosya Ekle'yi seçerek Yeni Dosya iletişim kutusunu açın:>

    Content menu items

  3. Sair > Boş Metin Dosyası'nıseçin ve ad.editorconfig verin. Dosyayı oluşturmak ve düzenleyicide açmak için Yeni'ye basın:

    New file dialog

    Öğeyi çözüm düzeyinde eklemek, öğeyi otomatik olarak oluşturur ve bir Çözüm Öğeleri klasörüne iç içe aktarır:

    Solution item displayed in Solution Window

  4. dosyasını düzenleyin. Örneğin:

    # This file is the top-most EditorConfig file
    root = true
    
    # All Files
    [*]
    indent_style = space
    indent_size = 8
    insert_final_newline = false
    trim_trailing_whitespace = false
    
    [*.cs]
    csharp_new_line_before_open_brace = none
    
  5. Dosyadaki .editorconfig ayarlar yazdığınız tüm yeni kodlara uygulanır, ancak mevcut kodun yeni ayarlarla tutarlı olması için yeniden biçimlendirilmesi gerekebilir. Dosyadaki .editorconfig ayarları var olan bir kaynak dosyaya uygulamak için dosyayı açın ve menü çubuğundan Biçim Biçimini > Düzenle > Belgesi'ni seçin:

    Format Document menu item

Var olan bir EditorConfig dosyası ekleme

Zaten dosya içeren .editorconfig bir proje veya çözümle çalışıyorsanız, ayarları uygulamak için yapmanız gereken hiçbir şey yoktur. Tüm yeni kod satırları EditorConfig ayarlarına göre biçimlendirilir.

Projenizde var olan .editorconfig bir dosyayı yeniden kullanmak isteyebilirsiniz. Var olan bir dosyayı eklemek için aşağıdakileri yapın:

  1. Eklemek istediğiniz klasöre sağ tıklayın ve Dosya Ekle'yi > seçin.

  2. Gerekli dosyanın dizinine göz atın.

  3. ile . başlayan dosyalar (örneğin.editorconfig) macOS'taki gizli dosyalardır, bu nedenle dosyayı görünür hale getirmek .editorconfig için Command + Shift + . tuşlarına basın.

  4. .editorconfig Dosyayı seçin ve Aç'a tıklayın:

    adding a new file window

  5. Size aşağıdaki iletişim kutusu sunulduğunda, Dosyayı dizine kopyala seçeneğini belirleyin ve Tamam'ı seçin:

    Add file to folder dialog options

.editorconfig ayarlarını Düşünceler

Codebase'inize bir EditorConfig dosyası eklediğinizde, eklenen tüm yeni kodlar belirtilen ayarlara göre otomatik olarak biçimlendirilir. Mevcut kod, kod tabanını biçimlendirmediğiniz sürece ayarları otomatik olarak yansıtmaz.

Dosyadaki .editorconfig ayarları yansıtmak için çözüm düğümünü seçin ve menü çubuğundan Biçim Biçimini > Düzenle > Belgesi'ni seçin:

Format document from the menu bar

EditorConfig dosyasını düzenleme

EditorConfig dosyaları, ayarları belirtmek için basit bir dosya düzeni kullanır ve bu, önceki bir örnek kullanılarak aşağıda açıklanmıştır:

# This file is the top-most EditorConfig file
root = true

# All Files
[*]
indent_style = space
indent_size = 4
insert_final_newline = false
trim_trailing_whitespace = false

[*.cs]
csharp_new_line_before_open_brace = none

true Ayarı root bu dosyayı kod tabanının en üstteki dosyası olarak işaretler ve EditorConfig Geçersiz Kılma Ayarlar bölümünde açıklandığı gibi projedeki daha yüksek .editorconfig dosyalar yoksayılır.

Her bölüm kare ([ ]) ayraçlarıyla gösterilir ve aşağıdaki özelliklerin ilgili olması gereken dosya türleriyle ilgili bilgileri belirtir.

Yukarıdaki örnekte, bazı ayarlar projedeki tüm dosyalara uygulanırken diğerleri yalnızca C# dosyalarına eklenir. Aşağıdaki ekran görüntüleri, ayarlar uygulanmadan önce ve uygulandıktan sonra .editorconfig gösterilir:

Önce:

Before editorconfig settings have been applied

Sonra:

after editorconfig settings have been applied

Kullanılabilir EditorConfig ayarları hakkında daha fazla bilgi için, resmi belgelerde EditorConfig için .NET kodlama kuralı ayarları makalesine ve Desteklenen Özellikler bölümüne bakın.

EditorConfig Ayarlar Geçersiz Kıl

Her çözümde birden .editorconfig fazla dosya olması mümkündür. Mac için Visual Studio çözümde dosyaları yukarıdan aşağıya doğru okur .editorconfig ve ayarlar eklenir ve geçersiz kılınabilir. Bu, düzenlediğiniz dosyaya .editorconfigen yakın ayarların öncelikli olacağı anlamına gelir. Ayarlar dosyadan .editorconfig aynı klasörden (varsa), ardından .editorconfig üst klasörden (varsa) alınır. öğesini bulana root=truekadar.

Kod tabanının bu bölümüne üst düzey .editorconfig dosyalardan hiçbir ayarın uygulanmadığından emin olmak istiyorsanız, alt düzey .editorconfig dosyanın en üstüne özelliğini ekleyinroot=true:

# top-most EditorConfig file
root = true

Ayrıca bkz.