У всех, кто запускал статический анализатор в первый раз на большом проекте, был небольшой шок по поводу сотен, тысяч или даже десятков тысяч предупреждений. Как-то грустно становится после такого. То ли код настолько плох, то ли анализатор привирает. В любом случае фильтрация по критичности поправляет ситуацию, правда не до конца. Поэтому мы и задумались, как можно улучшить первый опыт использования анализатора. Но обо всём по порядку...

Intelligence Diagnostic Filter

Что встречает человека, который впервые запустил статический анализатор на своём коде? Если проверялся большой проект, то обычно это огромное количество всевозможных предупреждений на различные участки кода.

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

Так и появилась идея разработать специальный механизм, который бы изучал список срабатываний и находил самые интересные среди них. Мы назвали его Intelligence Diagnostic Filter или сокращённо IDF.

Я не буду вдаваться в этой статье в детали его реализации. Об этом лучше всего расскажет разработчик, который занимался созданием этого механизма. Так что не забудьте подписаться на наш аккаунт на Habr, чтобы не пропустить его статью :)

Смотрим на первую десятку

Итак, вы установили анализатор – что дальше? Разумеется, нужно его запустить на достаточно большом проекте, иначе будет недостаточная отдача. Тут есть простая закономерность – чем больше строк кода, тем сложнее поддерживать его качество; а чем сложнее поддерживать его качество, тем больше багов.

Согласитесь, не очень-то хочется оценивать возможности анализатора, просматривая вот это всё подряд. Поэтому откройте дополнительный тулбар и нажмите на Best Warnings:

После недолгой обработки вы получите список самых значимых проблем в коде по версии IDF. Этот механизм разрабатывался также с целью продемонстрировать различные возможности анализатора, поэтому мы ограничили количество похожих срабатываний в выдаче. Благодаря этому вы сможете посмотреть сразу на различные типы проблем в коде. Это упростит дальнейшее изучение остальных срабатываний.

Примечание. Не забывайте помечать звёздочкой самые интересные срабатывания! Так вам будет легче их потом найти :)

Что дальше?

Разумеется, не стоит игнорировать остальные предупреждения. Режим Analyzer Best Warnings призван помочь вам убедиться в пользе PVS-Studio для вашего проекта и продемонстрировать возможности статического анализа. Поэтому после изучения 10 самых значимых проблем в коде по версии механизма IDF стоит вернуться и к другим предупреждениям.

Для того чтобы это сделать, достаточно ещё раз нажать на кнопку Best Warnings:

Теперь вы можете изучить все оставшиеся срабатывания. На самом деле, это необязательный этап. Вы можете, например, посмотреть только на уровень High:

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

Для этого нажмите на кнопку Suppress All Messages:

Теперь вы будете видеть срабатывания исключительно на новый код. Это очень полезный механизм, так что не бойтесь его использовать. Вы всегда сможете вернуть эти срабатывания обратно в лог из файла подавления.

Примечание. Предупреждения не исчезают без следа! Если вы отредактируете код рядом с подавленным срабатыванием, оно снова покажется вам.

Развитие IDF

Механизм умной фильтрации, конечно, будет развиваться и дальше. Analyzer Best Warnings – это первый функционал, основанный на его применении, но не последний :)

У нас есть различные мысли и идеи о том, как его ещё можно использовать. Например, добавить возможность сортировки всего отчёта. Это было бы удобно, так как впоследствии можно скрывать наименее достоверные срабатывания по версии IDF. Или же добавить возможность его точечной настройки для конкретных проектов...

Одним словом, идей огромное количество! Однако настоящей движущей силой изменений и перемен являются не разработчики, а пользователи. Это один из самых главных наших принципов – слушать желания аудитории.

Поэтому пробуйте новый функционал и пишите нам свои мысли и идеи! Благодаря этому мы не только узнаем, насколько вам понравился новый механизм, но и найдём правильный вектор его развития.

Дополнительные ссылки

• Как внедрить статический анализатор кода в legacy проект и не демотивировать команду

• Статический анализ – от знакомства до интеграции