.NET kaynak kodu analizine genel bakış

.NET derleyici platformu (Roslyn) çözümleyicileri C# veya Visual Basic kodunuzu kod kalitesi ve stil sorunları açısından inceler. .NET 5'den başlayarak, bu çözümleyiciler .NET SDK'sına eklenir ve bunları ayrı olarak yüklemeniz gerekmez. Projeniz .NET 5 veya üzerini hedeflediyse, kod analizi varsayılan olarak etkinleştirilir. Projeniz .NET Core, .NET Standard veya .NET Framework gibi farklı bir .NET uygulamasını hedef alıyorsa, EnableNETAnalyzers özelliğini olarak ayarlayarak kod analizini trueel ile etkinleştirmeniz gerekir.

.NET 5+ SDK'ya geçmek istemiyorsanız, SDK stilinde olmayan bir .NET Framework projeniz varsa veya NuGet paket tabanlı bir model tercih ediyorsanız çözümleyiciler Microsoft.CodeAnalysis.NetAnalyzers NuGet paketinde de kullanılabilir. İsteğe bağlı sürüm güncelleştirmeleri için paket tabanlı bir model tercih edebilirsiniz.

Kural ihlalleri bir çözümleyici tarafından bulunursa, her kuralın nasıl yapılandırıldığına bağlı olarak öneri, uyarı veya hata olarak bildirilir. Kod çözümleme ihlalleri, derleyici hatalarından ayırt etmek için "CA" veya "IDE" ön ekiyle birlikte görünür.

Kod kalitesi analizi

Kod kalitesi analizi ("CAxxxx") kuralları C# veya Visual Basic kodunuzu güvenlik, performans, tasarım ve diğer sorunlar açısından inceler. Analiz, .NET 5 veya üzerini hedefleyen projeler için varsayılan olarak etkindir. EnableNETAnalyzers özelliğini olarak ayarlayarak önceki .NET sürümlerini hedefleyen projelerde kod analizini trueetkinleştirebilirsiniz. olarak ayarlayarak EnableNETAnalyzers projeniz için kod analizini falsede devre dışı bırakabilirsiniz.

Etkin kurallar

Bu kuralları devre dışı bırakmak veya hatalara yükseltmek için önem derecesini değiştirebilirsiniz. Ayrıca daha fazla kuralı etkinleştirebilirsiniz.

• Her .NET SDK sürümüne dahil edilen kuralların listesi için bkz . Çözümleyici sürümleri.
• Tüm kod kalitesi kurallarının listesi için bkz . Kod kalitesi kuralları.

Ek kuralları etkinleştirme

Çözümleme modu , hiçbir kuralın, bazılarının veya tüm kuralların etkinleştirilmediği önceden tanımlanmış bir kod analizi yapılandırmasına başvurur. Varsayılan çözümleme modunda (Default ), derleme uyarısı olarak yalnızca az sayıda kural etkinleştirilir. Proje dosyasında özelliğini ayarlayarak <AnalysisMode> projenizin çözümleme modunu değiştirebilirsiniz. İzin verilebilen değerler şunlardır:

.NET 6'dan başlayarak, özelliği için <AnalysisLevel> bileşik değer yerine atlayabilirsiniz<AnalysisMode>. Örneğin, aşağıdaki değer en son sürüm için önerilen kural kümesini etkinleştirir: <AnalysisLevel>latest-Recommended</AnalysisLevel>. Daha fazla bilgi için bkz. AnalysisLevel.

Kullanılabilir her kuralın varsayılan önem derecesini ve kuralın analiz modunda etkinleştirilip etkinleştirilmediğini Default bulmak için kuralların tam listesine bakın.

Uyarıları hata olarak değerlendirin

Projelerinizi oluştururken bayrağını -warnaserror kullanırsanız, tüm kod analizi uyarıları da hata olarak değerlendirilir. Kod kalitesi uyarılarının (CAxxxx) varlığında -warnaserrorhata olarak değerlendirilmesini istemiyorsanız, proje dosyanızda MSBuild özelliğini olarak false ayarlayabilirsinizCodeAnalysisTreatWarningsAsErrors.

<PropertyGroup>
  <CodeAnalysisTreatWarningsAsErrors>false</CodeAnalysisTreatWarningsAsErrors>
</PropertyGroup>

Kod analizi uyarılarını görmeye devam edersiniz, ancak bunlar derlemenizi bozmaz.

En son güncelleştirmeler

Varsayılan olarak, .NET SDK'nın daha yeni sürümlerine yükselttikçe en son kod analizi kurallarını ve varsayılan kural önem derecelerini alırsınız. Örneğin, bu davranışı istemiyorsanız, yeni kuralların etkinleştirilmediğinden veya devre dışı bırakılmadığından emin olmak istiyorsanız, bunu aşağıdaki yollardan biriyle geçersiz kılabilirsiniz:

• Uyarıları bu AnalysisLevel kümeye kilitlemek için MSBuild özelliğini belirli bir değere ayarlayın. Daha yeni bir SDK'ya yükselttiğiniz zaman, bu uyarılar için hata düzeltmeleri almaya devam edersiniz, ancak yeni uyarı etkinleştirilmez ve mevcut uyarılar devre dışı bırakılmaz. Örneğin, kural kümesini .NET SDK'sının 5.0 sürümüyle birlikte gelenlere kilitlemek için proje dosyanıza aşağıdaki girdiyi ekleyin.

  <PropertyGroup>
    <AnalysisLevel>5.0</AnalysisLevel>
  </PropertyGroup>
  

  İpucu

  özelliğinin AnalysisLevel varsayılan değeri olur. latestBu, .NET SDK'sının daha yeni sürümlerine geçiş sırasında her zaman en son kod çözümleme kurallarını almanız anlamına gelir.

  Daha fazla bilgi edinmek ve olası değerlerin listesini görmek için bkz . AnalysisLevel.

• Kural güncelleştirmelerini .NET SDK güncelleştirmelerinden ayrıştırmak için Microsoft.CodeAnalysis.NetAnalyzers NuGet paketini yükleyin. .NET 5+ hedeflenen projeler için paketin yüklenmesi yerleşik SDK çözümleyicilerini kapatır. SDK, NuGet paketinden daha yeni bir çözümleyici derleme sürümü içeriyorsa bir derleme uyarısı alırsınız. Uyarıyı devre dışı bırakmak için özelliğini olarak trueayarlayın_SkipUpgradeNetAnalyzersNuGetWarning.

  Not

  Microsoft.CodeAnalysis.NetAnalyzers NuGet paketini yüklerseniz, EnableNETAnalyzers özelliğini proje dosyanıza veya Bir Directory.Build.props dosyasına eklememelisiniz. NuGet paketi yüklendiğinde ve EnableNETAnalyzers özelliği olarak trueayarlandığında bir derleme uyarısı oluşturulur.

Kod stili çözümleme

Kod stili analizi ("IDExxxx") kuralları, kod tabanınızda tutarlı kod stili tanımlamanızı ve korumanızı sağlar. Varsayılan etkinleştirme ayarları şunlardır:

• Komut satırı derlemesi: Kod stili çözümleme, komut satırı derlemelerindeki tüm .NET projeleri için varsayılan olarak devre dışıdır.

  .NET 5'den başlayarak, derlemede hem komut satırında hem de Visual Studio'da kod stili analizi etkinleştirebilirsiniz. Kod stili ihlalleri bir "IDE" ön ekiyle uyarı veya hata olarak görünür. Bu, derleme zamanında tutarlı kod stillerini zorunlu kılmanızı sağlar.

• Visual Studio: Kod stili çözümleme, kod yeniden düzenleme hızlı eylemleri olarak Visual Studio içindeki tüm .NET projeleri için varsayılan olarak etkindir.

Kod stili çözümleme kurallarının tam listesi için bkz . Kod stili kuralları.

Derlemede etkinleştir

.NET 5 SDK ve sonraki sürümleriyle, komut satırından ve Visual Studio'da derleme yaparken kod stili analizi etkinleştirebilirsiniz. (Ancak, performans nedenleriyle, birkaç kod stili kuralı yalnızca Visual Studio IDE'de geçerli olmaya devam eder.)

Derlemede kod stili analizini etkinleştirmek için şu adımları izleyin:

1. MSBuild özelliğini EnforceCodeStyleInBuild olarak trueayarlayın.

2. Bir .editorconfig dosyasında, derlemede bir uyarı veya hata olarak çalıştırmak istediğiniz her "IDE" kod stili kuralını yapılandırın . Örneğin:

   [*.{cs,vb}]
   # IDE0040: Accessibility modifiers required (escalated to a build warning)
   dotnet_diagnostic.IDE0040.severity = warning
   

   İpucu

   .NET 9'dan başlayarak, bir önem derecesi belirtmek ve derleme zamanında dikkate alınması için seçenek biçimini de kullanabilirsiniz. Örneğin:

   [*.{cs,vb}]
   # IDE0040: Accessibility modifiers required (escalated to a build warning)
   dotnet_style_require_accessibility_modifiers = always:warning
   

   Alternatif olarak, bir kategorinin tamamını varsayılan olarak bir uyarı veya hata olarak yapılandırabilir ve sonra bu kategorideki derlemede çalıştırmak istemediğiniz kuralları seçmeli olarak kapatabilirsiniz. Örneğin:

   [*.{cs,vb}]
   
   # Default severity for analyzer diagnostics with category 'Style' (escalated to build warnings)
   dotnet_analyzer_diagnostic.category-Style.severity = warning
   
   # IDE0040: Accessibility modifiers required (disabled on build)
   dotnet_diagnostic.IDE0040.severity = silent
   

Uyarıyı gizleme

Kural ihlalini gizlemenin bir yolu, bir EditorConfig dosyasında bu kural kimliği none için önem derecesi seçeneğini ayarlamaktır. Örneğin:

dotnet_diagnostic.CA1822.severity = none

Daha fazla bilgi ve uyarıları gizlemenin diğer yolları için bkz . Kod analizi uyarılarını gizleme.

Üçüncü taraf çözümleyiciler

Resmi .NET çözümleyicilerine ek olarak StyleCop, Roslynator, XUnit Analyzers ve Sonar Analyzer gibi üçüncü taraf çözümleyicileri de yükleyebilirsiniz.

Ayrıca bkz.

• Kod kalitesi analizi kuralı başvurusu
• Kod stili çözümleme kuralı başvurusu
• Visual Studio'da kod analizi
• .NET Derleyici Platformu SDK'sı
• Öğretici: İlk çözümleyicinizi ve kod düzeltmenizi yazma
• ASP.NET Core uygulamalarında kod analizi