A .NET-forráskódelemzés áttekintése

A .NET fordítóplatform (Roslyn) elemzői ellenőrzik a C# vagy a Visual Basic kód minőségét és stílusát. A .NET 5-től kezdve ezek az elemzők a .NET SDK részét képezik, és nem kell külön telepíteni őket. Ha a projekt a .NET 5-ös vagy újabb verzióját célozza meg, a kódelemzés alapértelmezés szerint engedélyezve van. Ha a projekt egy másik .NET-implementációt céloz meg, például .NET Core, .NET Standard vagy .NET-keretrendszer, manuálisan engedélyeznie kell a kódelemzést az EnableNETAnalyzers tulajdonság truebeállításával.

Ha nem szeretne a .NET 5+ SDK-ra váltani, nem SDK-stílusú .NET-keretrendszer projektje van, vagy inkább Egy NuGet-csomagalapú modellt szeretne, az elemzők a Microsoft.CodeAnalysis.NetAnalyzers NuGet csomagban is elérhetők. Igény szerinti verziófrissítésekhez érdemes csomagalapú modellt használni.

Ha egy elemző szabálysértéseket talál, a rendszer javaslatként, figyelmeztetésként vagy hibaként jelenti őket az egyes szabályok konfigurálásának módjától függően. A kódelemzési szabálysértések a "CA" vagy az "IDE" előtaggal jelennek meg, hogy megkülönböztessék őket a fordítóhibáktól.

Kódminőség-elemzés

A kódminőség-elemzés ("CAxxxx") szabályai biztonsági, teljesítménybeli, tervezési és egyéb problémák esetén ellenőrzik a C# vagy a Visual Basic kódot. Az elemzés alapértelmezés szerint engedélyezve van a .NET 5 vagy újabb verziót célzó projektek esetében. Az EnableNETAnalyzers tulajdonság beállításával true A projekt kódelemzését a következő beállítással EnableNETAnalyzersfalseis letilthatja: .

Engedélyezett szabályok

A szabályok súlyosságát módosíthatja, hogy letiltsa őket, vagy hibákra emelje őket. További szabályokat is engedélyezhet.

• Az egyes .NET SDK-verziókhoz tartozó szabályok listáját az Analyzer kiadásaiban találja.
• Az összes kódminőségi szabály listáját a Kódminőségi szabályok című témakörben találja.

További szabályok engedélyezése

Az elemzési mód egy előre definiált kódelemzési konfigurációra utal, amelyben nincs, néhány vagy minden szabály engedélyezve van. Az alapértelmezett elemzési módban (Default) a rendszer csak kis számú szabályt engedélyez összeállítási figyelmeztetésként. A projekt elemzési módjának módosításához állítsa be a <AnalysisMode> tulajdonságot a projektfájlban. Az engedélyezett értékek a következők:

A tulajdonság összetett értékét <AnalysisMode> is kihagyhatja<AnalysisLevel>. A következő érték például a legújabb kiadáshoz javasolt szabálykészletet teszi lehetővé: <AnalysisLevel>latest-Recommended</AnalysisLevel>. További információ: AnalysisLevel.

Ha meg szeretné állapítani az egyes elérhető szabályok alapértelmezett súlyosságát, és hogy a szabály engedélyezve van-e elemzési Default módban, tekintse meg a szabályok teljes listáját.

Figyelmeztetések kezelése hibákként

Ha a projektek létrehozásakor használja a -warnaserror jelzőt, a kódelemzési figyelmeztetések is hibaüzenetként lesznek kezelve. Ha nem szeretné, hogy a kódminőségre vonatkozó figyelmeztetések (CAxxxx) hibákként -warnaserrorlegyenek kezelve, beállíthatja az CodeAnalysisTreatWarningsAsErrors MSBuild tulajdonságot false a projektfájlban.

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

A kódelemzési figyelmeztetések továbbra is megjelennek, de nem fogják megszakítani a buildet.

Legújabb frissítések

Alapértelmezés szerint a .NET SDK újabb verzióira való frissítéskor a legújabb kódelemzési szabályokat és az alapértelmezett szabály súlyosságait fogja megkapni. Ha nem szeretné ezt a viselkedést, például ha meg szeretné győződni arról, hogy nincsenek új szabályok engedélyezve vagy letiltva, felülbírálhatja az alábbi módokon:

• Állítsa az AnalysisLevel MSBuild tulajdonságot egy adott értékre, hogy zárolja a figyelmeztetéseket erre a halmazra. Az újabb SDK-ra való frissítéskor továbbra is hibajavítások jelennek meg ezekhez a figyelmeztetésekhez, de új figyelmeztetések nem lesznek engedélyezve, és a meglévő figyelmeztetések nem lesznek letiltva. Ha például a szabálykészletet a .NET SDK 8.0-s verziójával szállítja, adja hozzá a következő bejegyzést a projektfájlhoz.

  <PropertyGroup>
    <AnalysisLevel>8.0</AnalysisLevel>
  </PropertyGroup>
  

  Tipp.

  A tulajdonság AnalysisLevelalapértelmezett értéke, latest ami azt jelenti, hogy a .NET SDK újabb verzióira való áttéréskor mindig a legújabb kódelemzési szabályokat kapja meg.

  További információkért és a lehetséges értékek listájának megtekintéséhez tekintse meg az AnalysisLevelet.

• Telepítse a Microsoft.CodeAnalysis.NetAnalyzers NuGet-csomagot a szabályfrissítések .NET SDK-frissítésektől való leválasztásához. A .NET 5+-et megcélzó projektek esetében a csomag telepítése kikapcsolja a beépített SDK-elemzőket. Buildre vonatkozó figyelmeztetést kap, ha az SDK a NuGet-csomagénál újabb elemzőszerelvény-verziót tartalmaz. A figyelmeztetés letiltásához állítsa a tulajdonságot a _SkipUpgradeNetAnalyzersNuGetWarning következőre true: .

  Feljegyzés

  Ha telepíti a Microsoft.CodeAnalysis.NetAnalyzers NuGet-csomagot, nem szabad hozzáadnia az EnableNETAnalyzers tulajdonságot sem a projektfájlhoz, sem a Directory.Build.props fájlhoz . Ha a NuGet-csomag telepítve van, és a EnableNETAnalyzers tulajdonság értéke be van állítva true, létrejön egy összeállítási figyelmeztetés.

Kódstílus-elemzés

A kódstílus-elemzés ("IDExxxx") szabályai lehetővé teszik, hogy konzisztens kódstílust definiáljon és tartson fenn a kódbázisban. Az alapértelmezett engedélyezési beállítások a következők:

• Parancssori build: A kódstílus-elemzés alapértelmezés szerint le van tiltva a parancssori buildeken lévő összes .NET-projekt esetében.

  A kódstílus-elemzést a buildeléskor engedélyezheti a parancssorban és a Visual Studióban is. A kódstílusok megsértései figyelmeztetésként vagy "IDE" előtaggal kapcsolatos hibákként jelennek meg. Ez lehetővé teszi a konzisztens kódstílusok kikényszerítését a létrehozáskor.

• Visual Studio: A kódstílus-elemzés alapértelmezés szerint engedélyezve van a Visual Studióban lévő összes .NET-projekthez, mint a gyorsműveletek kódjának újrabontása.

A kódstílus-elemzési szabályok teljes listáját a Kódstílus-szabályok című témakörben találja.

Engedélyezés builden

A kódstílus-elemzést a parancssorból és a Visual Studióban való készítéskor engedélyezheti. (Teljesítménybeli okokból azonban néhány kódstílus-szabály továbbra is csak a Visual Studio IDE-ben lesz érvényben.)

Kövesse az alábbi lépéseket a kódstílusok builden történő elemzésének engedélyezéséhez:

1. Állítsa az MSBuild EnforceCodeStyleInBuild tulajdonságot a következőretrue: .

2. A .editorconfig fájlban konfiguráljon minden olyan "IDE" kódstílus-szabályt, amelyet figyelmeztetésként vagy hibaként szeretne futtatni a builden. Példa:

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

   Tipp.

   A .NET 9-től kezdődően a beállításformátumot is használhatja a súlyosság megadásához, és a létrehozáskor figyelembe kell venni. Példa:

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

   Másik lehetőségként konfigurálhat egy teljes kategóriát alapértelmezés szerint figyelmeztetésként vagy hibaként, majd szelektíven kikapcsolhatja a szabályokat abban a kategóriában, amelyet nem szeretne builden futtatni. Példa:

   [*.{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
   

Figyelmeztetés mellőzése

A szabálysértések letiltásának egyik módja, ha az adott szabályazonosító none súlyossági beállítását egy Szerkesztőkonfigurációs fájlban állítja be. Példa:

dotnet_diagnostic.CA1822.severity = none

További információkért és a figyelmeztetések letiltásának egyéb módjaiért lásd : Kódelemzési figyelmeztetések letiltása.

Külső elemzők

A hivatalos .NET-elemzők mellett külső elemzőket is telepíthet, például StyleCop, Roslynator, XUnit Analyzers és Sonar Analyzer.

Lásd még

• Kódminőség-elemzési szabály referenciája
• Kódstílus-elemzési szabály referenciája
• Kódelemzés a Visual Studióban
• .NET Fordítóplatform SDK
• Oktatóanyag: Az első elemző és kódjavítás írása
• Kódelemzés ASP.NET Core-alkalmazásokban