Поделиться через

Анализ кода

Анализаторы кода можно использовать для поиска потенциальных проблем в коде приложения .NET Framework. Анализаторы находят потенциальные проблемы и предлагают исправления для них.

Анализаторы кода на основе Roslyn выполняются интерактивно в Visual Studio при написании кода или в рамках сборки CI. Вы должны добавить анализаторы в проект как можно раньше в цикле разработки. Чем раньше вы найдете потенциальные проблемы в коде, тем проще их устранить. Анализаторы помечают проблемы в существующем коде и предупреждают о новых проблемах при продолжении разработки.

Замечание

В этой статье используется устаревший пакет NuGet Microsoft.NetFramework.Analyzers. Начиная с .NET 5 анализаторы NET включены в пакет SDK для .NET. При необходимости вы можете использовать пакет NuGet Microsoft.CodeAnalysis.NetAnalyzers. Дополнительные сведения см. в разделе "Анализ кода" в .NET.

Установка и настройка анализаторов

Анализатор .NET Framework поставляется в пакете NuGet Microsoft.NetFramework.Analyzers . Этот пакет предоставляет анализаторы, относящиеся к API .NET Framework, которые включают анализаторы безопасности. Пакет включается в пакет Microsoft.CodeAnalysis.FxCopAnalyzers, поэтому при установке этого пакета не требуется устанавливать анализаторы .NET Framework отдельно.

Установите пакет NuGet в каждом проекте, где нужно запустить анализаторы. Только один разработчик должен добавить их в проект. Пакет анализатора — это зависимость проекта, который будет выполняться на каждом компьютере разработчика после обновления решения.

Чтобы установить пакет, щелкните проект правой кнопкой мыши и выберите пункт "Управление зависимостями". В обозревателе NuGet найдите "Microsoft.NetFramework.Analyzers". Установите последнюю стабильную версию во всех проектах вашего решения.

Использование анализаторов

После установки пакета NuGet создайте решение. Анализатор сообщит о любых проблемах, обнаруженных в базе кода. Проблемы отображаются как предупреждения в окне списка ошибок Visual Studio, как показано на следующем рисунке:

Проблемы, сообщаемые анализаторами .NET Framework.

При написании кода под потенциальными проблемами отображаются волнистые линии. Наведите указатель мыши на любую проблему, чтобы получить дополнительные сведения и просмотреть предложения по любому возможному исправлению, как показано на следующем рисунке:

Интерактивный отчет о проблемах, обнаруженных анализаторами кода.

Дополнительные сведения см. в разделе "Анализ кода" в Visual Studio.

Типы правил

Анализаторы проверяют код в вашем решении и выводят предупреждения с префиксом CA. Список всех возможных предупреждений см. в разделе "Правила качества кода". Только некоторые из этих предупреждений применяются к API .NET Framework, в том числе:

См. также