Прочитать на английском

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


Анализ кода

Анализаторы кода можно использовать для поиска потенциальных проблем в коде приложения платформа .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. Этот пакет предоставляет анализаторы, относящиеся к платформа .NET Framework API, которые включают анализаторы безопасности. Пакет входит в пакет Microsoft.CodeAnalysis.FxCopAnalyzers, поэтому при установке этого пакета не требуется устанавливать анализаторы платформа .NET Framework отдельно.

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

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

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

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

Issues reported by .NET Framework analyzers.

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

Interactive report of issues found by code analyzers.

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

Типы правил

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

См. также