dotnet biçimi

Bu makale şunlar için geçerlidir: ✔️ .NET 6 SDK ve sonraki sürümler

Veri Akışı Adı

dotnet format - Kodu ayarlarla eşleşecek şekilde editorconfig biçimlendirin.

Özet

dotnet format [<PROJECT | SOLUTION>]
  [--binarylog <BINARY-LOG-PATH>] [--diagnostics <DIAGNOSTICS>]
  [--exclude <EXCLUDE>] [--exclude-diagnostics <EXCLUDE-DIAGNOSTICS>]
  [--include <INCLUDE>] [--include-generated]
  [--no-restore] [--report <REPORT-PATH>] [--severity <LEVEL>]
  [-v|--verbosity <LEVEL>] [--verify-no-changes] [--version]

dotnet format -h|--help

Açıklama

dotnet format , stil tercihlerini ve statik analiz önerilerini bir projeye veya çözüme uygulayan bir kod biçimlendiricidir. Tercihler varsa bir .editorconfig dosyasından okunur, aksi takdirde varsayılan bir tercih kümesi kullanılır. Daha fazla bilgi için EditorConfig belgelerine bakın.

Bağımsız değişkenler

PROJECT | SOLUTION

Kod biçimlendirmesini çalıştırmak için MSBuild projesi veya çözümü. Bir proje veya çözüm dosyası belirtilmezse, MSBuild geçerli çalışma dizininde proj veya sln ile biten dosya uzantısına sahip bir dosya arar ve bu dosyayı kullanır.

Dikkat

dotnet biçimi, belirtilen proje veya çözümden çözümleyicileri geri yükleyebilir, derleyip çalıştırabilir. Aracı yalnızca güvenilen koda karşı çağırın.

Seçenekler

Komutun başarılı olması için dotnet format aşağıdaki seçeneklerden hiçbiri gerekli değildir, ancak bunları hangi biçimlendirilmiş ve hangi kurallara göre daha fazla özelleştirmek için kullanabilirsiniz.

• --binarylog <BINARY-LOG-PATH>

  Tüm proje veya çözüm yükleme bilgilerini ikili günlük dosyasına kaydeder.

• --diagnostics <DIAGNOSTICS>

  Kod stili veya üçüncü taraf sorunları düzeltirken filtre olarak kullanılacak tanılama kimliklerinin boşlukla ayrılmış listesi. Varsayılan değer, .editorconfig dosyasında listelenen kimliklerdir. Belirtebileceğiniz yerleşik çözümleyici kuralı kimliklerinin listesi için kod çözümleme stili kurallarının kimlik listesine bakın.

• --exclude <EXCLUDE>

  Biçimlendirmenin dışında tutulacak göreli dosya veya klasör yollarının boşlukla ayrılmış listesi. Varsayılan değer none'dır.

• --exclude-diagnostics <EXCLUDE-DIAGNOSTICS>

  Kod stili veya üçüncü taraf sorunları düzeltirken dışlanması gereken tanılama kimliklerinin boşlukla ayrılmış listesi. Varsayılan değer yok. Belirtebileceğiniz yerleşik çözümleyici kuralı kimliklerinin listesi için kod çözümleme stili kurallarının kimlik listesine bakın.

• --include <INCLUDE>

  Biçimlendirmeye eklenecek göreli dosya veya klasör yollarının boşlukla ayrılmış listesi. Varsayılan değer çözümdeki veya projedeki tüm dosyalardır.

• --include-generated

  SDK tarafından oluşturulan dosyaları biçimlendirin.

• --no-restore

  Biçimlendirmeden önce örtük geri yükleme yürütmez. Varsayılan, örtük geri yükleme yapmaktır.

• --report <REPORT-PATH>

  tarafından <REPORT_PATH>belirtilen dizinde bir JSON raporu oluşturur.

• --severity <LEVEL>

  Düzeltilmesi gereken tanılamaların en düşük önem derecesi. İzin verilen değerler , infove warndeğerleridirerror. Varsayılan değer şudur: warn.

• --verify-no-changes

  Biçimlendirme değişikliği gerçekleştirilmeyeceğini doğrular. Herhangi bir dosya biçimlendirilmiş olsaydı sıfır olmayan bir çıkış koduyla sonlandırılır.

• --version

  Sürüm bilgilerini görüntüler.

• -v|--verbosity <LEVEL>

  Komutun ayrıntı düzeyini ayarlar. İzin verilen değerler , q[uiet], m[inimal], n[ormal]ve d[etailed]değerleridirdiag[nostic]. Daha fazla bilgi için bkz. LoggerVerbosity.

• -?|-h|--help

  komutunun nasıl kullanılacağına ilişkin bir açıklama yazdırır.

Alt Komutlar

Whitespace

dotnet format whitespace - Kodu boşluk ayarlarıyla eşleşecek editorconfig şekilde biçimlendirin.

Açıklama

Alt dotnet format whitespace komut yalnızca boşluk biçimlendirmesiyle ilişkili biçimlendirme kurallarını çalıştırır. .editorconfig dosyanızda belirtebileceğiniz olası biçimlendirme seçeneklerinin tam listesi için C# biçimlendirme seçeneklerine bakın.

Seçenekler

• --folder

  bağımsız değişkenini <PROJECT | SOLUTION> basit bir kod dosyaları klasörünün yolu olarak değerlendirin.

Stil

dotnet format style - Kodu, kod stili için EditorConfig ayarlarıyla eşleşecek şekilde biçimlendirin.

Açıklama

Alt dotnet format style komut yalnızca kod stili biçimlendirmesiyle ilişkili biçimlendirme kurallarını çalıştırır. Dosyanızda editorconfig belirtebileceğiniz biçimlendirme seçeneklerinin tam listesi için bkz . Kod stili kuralları.

Seçenekler

• --diagnostics <DIAGNOSTICS>

  Kod stili sorunlarını düzeltirken filtre olarak kullanılacak tanılama kimliklerinin boşlukla ayrılmış listesi. Varsayılan değer, .editorconfig dosyasında listelenen kimliklerdir. Belirtebileceğiniz yerleşik kod stili çözümleyici kuralı kimliklerinin listesi için kod çözümleme stili kurallarının kimlik listesine bakın.

• --severity <LEVEL>

  Düzeltilmesi gereken tanılamaların en düşük önem derecesi. İzin verilen değerler , infove warndeğerleridirerror. Varsayılan değer: warn

Çözümleyiciler

dotnet format analyzers - Kod, çözümleyicilerin ayarlarıyla eşleşecek editorconfig şekilde biçimlendirildi (kod stili kuralları hariç).

Açıklama

Alt dotnet format analyzers komut yalnızca çözümleyicilerle ilişkili biçimlendirme kurallarını çalıştırır. Dosyanızda editorconfig belirtebileceğiniz çözümleyici kurallarının listesi için bkz . Kalite kuralları.

Seçenekler

• --diagnostics <DIAGNOSTICS>

  Kod stili olmayan sorunları düzeltirken filtre olarak kullanılacak tanılama kimliklerinin boşlukla ayrılmış listesi. Varsayılan değer, .editorconfig dosyasında listelenen kimliklerdir. Belirtebileceğiniz yerleşik çözümleyici kuralı kimliklerinin listesi için kalite kuralları kimlikleri listesine bakın. Üçüncü taraf çözümleyiciler için belgelerine bakın.

• --severity <LEVEL>

  Düzeltilmesi gereken tanılamaların en düşük önem derecesi. İzin verilen değerler , infove warndeğerleridirerror. Varsayılan değer şudur: warn.

Örnekler

• Çözümdeki tüm kodları biçimlendirin:

  dotnet format ./solution.sln
  

• Uygulama projesindeki tüm kodları temizleyin:

  dotnet format ./src/application.csproj
  

• Tüm kodun doğru biçimlendirildiğini doğrulayın:

  dotnet format --verify-no-changes
  

• src ve tests dizinindeki tüm kodları temizleyin, ancak src/submodule-a içinde temizlemeyin:

  dotnet format --include ./src/ ./tests/ --exclude ./src/submodule-a/
  

• Belirli bir kod stili sorununu düzeltin:

  dotnet format style --diagnostics IDE0005 --severity info
  

• Önem derecesi info olan tüm warning sorunlarını düzeltin veya error:

  dotnet format style --severity info
  

• Belirli bir (kod stili olmayan) çözümleyici sorunu düzeltildi:

  dotnet format analyzers --diagnostics CA1831 --severity warn
  

• Önem derecesi infowarning olan tüm kod stili olmayan sorunları düzeltin veya error:

  dotnet format analyzers --severity info