Udostępnij za pośrednictwem

analiza kodu

Możesz użyć analizatorów kodu, aby znaleźć potencjalne problemy w kodzie aplikacji .NET Framework. Analizatory znajdują potencjalne problemy i sugerują ich poprawki.

Analizatory kodu oparte na platformie Roslyn działają interaktywnie w programie Visual Studio podczas pisania kodu lub jako część buildu ciągłej integracji. Analizatory należy dodać do projektu tak szybko, jak to możliwe, w cyklu projektowania. Im szybciej znajdziesz potencjalne problemy w kodzie, tym łatwiej jest je rozwiązać. Analizatory flagują problemy w istniejącym kodzie i ostrzegają o nowych problemach podczas kontynuowania programowania.

Uwaga / Notatka

Ten artykuł korzysta z przestarzałego pakietu NuGet Microsoft.NetFramework.Analyzers. Począwszy od platformy .NET 5, analizatory NET są dołączone do zestawu .NET SDK. W razie potrzeby możesz zamiast tego użyć pakietu NuGet Microsoft.CodeAnalysis.NetAnalyzers . Aby uzyskać więcej informacji, zobacz Analiza kodu na platformie .NET.

Instalowanie i konfigurowanie analizatorów

Analizator .NET Framework jest dostarczany w pakiecie NuGet Microsoft.NetFramework.Analyzers . Ten pakiet udostępnia analizatory specyficzne dla interfejsów API programu .NET Framework, które obejmują analizatory zabezpieczeń. Pakiet jest dołączony do pakietu Microsoft.CodeAnalysis.FxCopAnalyzers, więc w przypadku zainstalowania tego pakietu nie ma potrzeby oddzielnego instalowania analizatorów programu .NET Framework.

Zainstaluj pakiet NuGet w każdym projekcie, w którym mają być uruchamiane analizatory. Tylko jeden deweloper musi dodać je do projektu. Pakiet analizatora jest zależnością projektu i będzie uruchamiany na maszynie każdego dewelopera po zaktualizowaniu rozwiązania.

Aby zainstalować pakiet, kliknij prawym przyciskiem myszy projekt i wybierz pozycję "Zarządzaj zależnościami". W eksploratorze NuGet wyszukaj "Microsoft.NetFramework.Analyzers". Zainstaluj najnowszą stabilną wersję we wszystkich projektach w rozwiązaniu.

Korzystanie z analizatorów

Po zainstalowaniu pakietu NuGet skompiluj rozwiązanie. Analizator zgłosi wszelkie problemy, które znajdzie w bazie kodu. Problemy są zgłaszane jako ostrzeżenia w oknie Lista błędów programu Visual Studio, jak pokazano na poniższej ilustracji:

Problemy zgłaszane przez analizatory programu .NET Framework.

Podczas pisania kodu widzisz falowane podkreślenia pod każdym potencjalnym problemem w kodzie. Zatrzymaj wskaźnik myszy na dowolnym problemie, aby uzyskać więcej informacji i wyświetlić sugestie dotyczące wszelkich możliwych poprawek, jak pokazano na poniższej ilustracji:

Interaktywny raport problemów znalezionych przez analizatory kodu.

Aby uzyskać więcej informacji, zobacz Analiza kodu w programie Visual Studio.

Typy reguł

Analizatory sprawdzają kod w rozwiązaniu i wyświetlają ostrzeżenia z prefiksem CA . Aby uzyskać listę wszystkich możliwych ostrzeżeń, zobacz Reguły jakości kodu. Tylko niektóre z tych ostrzeżeń dotyczą interfejsów API programu .NET Framework, w tym:

Zobacz także