Özel bir EditorConfig dosyası oluşturma ve düzenleniyor

  • Makale
  • Okumak için 3 dakika

Mac için Visual Studio, kod tabanında çalıştırılan herkes için tutarlı kodlama stillerini zorlamak üzere projenize veya çözümünüze bir editorconfig dosyası ekleyebilirsiniz. editorconfig dosyasında belirtilen 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 tarzınızı, tercihlerinizi ve uyarılarını ayarlamanıza olanak sağlar. Dosya, kod tabanınızın bir parçası olduğundan, kullandıkları IDE veya kod düzenleyiciden bağımsız olarak tüm kullanıcıların bir projenin kodlama uygulamalarına bağlı olmasını kolaylaştırır.

Editorconfig dosyaları, Visual Studio dahil olmak üzere birçok Ides ve kod düzenleyicilerinde desteklenir.

Desteklenen ayarlar

Mac için Visual Studio 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# ' de kodlama kurallarını da destekler.

Bir projeye EditorConfig dosyası ekleme

Yeni bir EditorConfig dosyası ekleniyor

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

  2. Düğüme sağ tıklayıp yeni dosya iletişim kutusunu açmak Için > yeni dosya Ekle ' yi seçin:

    İçerik menü öğeleri

  3. Çeşitli > boş metin dosyası ' nı seçin ve adı verin .editorconfig . Yeni ' ye basarak dosyayı oluşturun ve düzenleyicide açın:

    Yeni dosya iletişim kutusu

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

    Çözüm penceresinde görünen çözüm öğesi

  4. Dosyayı düzenleyin. Örnek:

    # 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. .editorconfigDosyadaki ayarlar yazdığınız tüm yeni kodlar için geçerli olacaktır, ancak mevcut kodun yeni ayarlarla tutarlı olacak şekilde yeniden biçimlendirilmesi gerekebilir. Ayarları .editorconfig dosyadan var olan bir kaynak dosyasına uygulamak için dosyayı açın ve menü çubuğundan > Biçimlendir > Biçimlendir ' i seçin::

    Belge menü öğesini Biçimlendir

Mevcut bir EditorConfig dosyası ekleniyor

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

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

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

  2. Gerekli dosyanın dizinine gidin.

  3. .(Gibi) ile başlayan dosyalar .editorconfig MacOS 'ta gizli dosyalardır, bu nedenle Command + SHIFT + tuşlarına basın. dosyayı görünür hale getirmek için .editorconfig .

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

    Yeni dosya penceresi ekleme

  5. Aşağıdaki iletişim kutusunda, dosyayı dizine Kopyala seçeneğini belirleyin ve Tamam' ı seçin:

    Klasöre dosya Ekle iletişim kutusu seçenekleri

. Editorconfig ayarlarını yansıtma

Kod tabanınıza bir EditorConfig dosyası ekledikten sonra eklenen her yeni kod, belirtilen ayarlara göre otomatik olarak biçimlendirilir. Kod temeli biçimlendirmediğiniz takdirde mevcut kod otomatik olarak ayarları yansıtmaz.

Dosyadaki ayarları yansıtmak için .editorconfig , çözüm düğümünü seçin ve menü çubuğundan > Biçimlendir > Biçimlendir belge Biçimlendir ' i seçin:

Menü çubuğundan belge biçimlendirme

EditorConfig dosyasını Düzenle

EditorConfig dosyaları, daha önceki bir örnek kullanılarak aşağıda açıklanan ayarları belirtmek için basit bir dosya düzeni kullanı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

root true bu dosyayı, kod temelinin en üstteki dosyası olarak bayraklar ve projedeki tüm daha yüksek .editorconfig dosyalar, geçersiz kılma editorconfig Ayarlar bölümünde açıklandığı gibi yok sayılır.

Her bölüm kare ([]) ayraçları ile gösterilir ve aşağıdaki özelliklerin ait olduğu dosya türleri hakkında bilgi belirtir.

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

Önce:

Editorconfig ayarları uygulanmadan önce

Sonra:

editorconfig ayarları uygulandıktan sonra

Kullanılabilir EditorConfig ayarları hakkında daha fazla bilgi için bkz. editorconfig için .net kodlama kuralı ayarları ve resmi belgelerindeki desteklenen özellikler bölümü.

editorconfig Ayarlar geçersiz kıl

Her çözümde birden çok dosya olması mümkündür .editorconfig . Mac için Visual Studio .editorconfig çözümdeki en yukarıdan aşağıya kadar dosya okur, bu ayarları olduğu gibi ekleyip geçersiz kılar. Bu, .editorconfig düzenlemekte olduğunuz dosyaya en yakın ayarların öncelikli olacağı anlamına gelir. Ayarlar, .editorconfig dosyadan aynı klasöre (varsa), ardından .editorconfig üst klasöre (varsa), vb. alınır. bulana kadar root=true .

Kod temelinin bu bölümüne daha üst düzey bir dosyanın hiçbir ayarlarının uygulanmadığından emin olmak istiyorsanız .editorconfig , root=true özelliği alt düzey dosyanın en üstüne ekleyin .editorconfig :

# top-most EditorConfig file
root = true

Ayrıca bkz.