Для получения триального ключа
заполните форму ниже
Team License (базовая версия)
Enterprise License (расширенная версия)
* Нажимая на кнопку, вы даете согласие на обработку
своих персональных данных. См. Политику конфиденциальности

Запросите информацию о ценах
Новая лицензия
Продление лицензии
--Выберите валюту--
USD
EUR
GBP
RUB
* Нажимая на кнопку, вы даете согласие на обработку
своих персональных данных. См. Политику конфиденциальности

Бесплатная лицензия PVS-Studio для специалистов Microsoft MVP
* Нажимая на кнопку, вы даете согласие на обработку
своих персональных данных. См. Политику конфиденциальности

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

Мне интересно попробовать плагин на:
* Нажимая на кнопку, вы даете согласие на обработку
своих персональных данных. См. Политику конфиденциальности

Ваше сообщение отправлено.

Мы ответим вам на


Если вы так и не получили ответ, пожалуйста, проверьте папку
Spam/Junk и нажмите на письме кнопку "Не спам".
Так Вы не пропустите ответы от нашей команды.

>
>
PVS-Studio Output Window vs plain text …

PVS-Studio Output Window vs plain text stdout

12 Окт 2011

В беседах с программистами, которые подумывают об использовании статического анализатора кода, часто можно слышать такое мнение: "Никакого особенного интерфейса для такого инструмента не надо, достаточно просто command line tool. Да и вывод (stdout) всегда можно сохранить в файл". Я хочу показать ошибочность такого подхода на примере окна результатов PVS-Studio Output Window.

0111-Output_window_vs_plain_text_stdout_ru/image1.png

Итак, какую минимально-необходимую информацию сообщает в своем отчете любой статический анализатор кода или компилятор, который выдает список сообщений об ошибках:

  • код ошибки;
  • текст сообщения;
  • имя файла;
  • номер строки.

Действительно, на первый взгляд кажется, что эту информацию вполне можно представить в виде текстового файла или вывести на экран (stdout). И подавляющее большинство компиляторов так и делает. А что же статические анализаторы? Может им тоже достаточно "выплюнуть все в stdout"? И как уловить отличие?

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

Работая с компилятором, человек получает не так уж много сообщений от него. Как правило, это несколько сообщений об ошибках (не более десяти), и может быть чуть больше (несколько десятков максимум) предупреждений. При этом хорошим стилем является полное отсутствие предупреждений в проекте. Естественно, бывают случаи, когда ошибок компиляции существенно больше, но они в общем количестве достаточно редки (случае переноса кода на другую платформу либо глобальные изменения в используемых библиотеках). Итак, еще раз, в обычном режиме работы пользователь получает от компилятора лишь несколько сообщений об ошибках.

Работа со статическим анализатором идет в другом ключе. Как правило, статический анализатор "натравливается" уже на существующий проект. Причем, чем больше проект, тем больше желание команды использовать статический анализатор. Что из этого следует? А то, что запуск на маленьком проекте даст сотни сообщений, на среднем – тысячи, а на крупном (годы командной разработки) может быть даже десятки тысяч сообщений. И со всеми этими сообщениями нужно как-то работать, анализировать их и т.п.

Так чем же отличается современное окно результатов статического анализатора кода (на примере PVS-Studio) от plain text stdout? Перечислю сначала стандартные вещи, многие из которых есть в том же окне Error List в Visual Studio (хотя для stdout и это не доступно):

  • Навигация по коду. Представьте себе, что вы берете и начинаете изучать новый инструмент. Одно дело, если нужные строки кода вам придется искать в проекте руками или создать специальную утилиту, которая превратит лог в нечто, что может использовать среда разработки для навигации. И совсем другое дело, если вы просто два раза кликнете мышкой по диагностическому сообщению. Согласитесь, что в первом варианте изучение инструмента может закончиться, даже толком не начавшись.
  • Сортировка. На первый взгляд не обязательная операция. Но если вы захотите работать с большим проектом, то она вам обязательно понадобится.
  • Быстрый и удобный доступ к справке по коду ошибки.

Теперь возможности окна, важные именно для статического анализатора.

  • Возможность пометить некоторые сообщения как ложные срабатывания ("Mark As False Alarm"). Например, в PVS-Studio это сделано через добавление в код специального комментария вида "//-V124". Но размещать такой код вручную неудобно (хотя никто не мешает), поэтому проще кликнуть в окне "Mark As False Alarm". Простой текстовый вывод не позволит удобно использовать этот механизм.
  • Возможность на лету фильтровать сообщения. Можно скрыть или показать сообщения с определенным кодом ошибки, содержащие какие-то конкретные слова и т.п. Это очень удобно, так как сообщений много и перезапуск анализатора – длительная задача. Конечно, тут можно попробовать возразить, что есть чудесные unix-утилиты вроде grep, sed, awk и так далее, но это, мягко говоря, на любителя.

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

Пять перечисленных возможностей окна вывода сообщений наглядно показывают, что работать со статическим анализатором намного удобнее, когда у него есть подобный интерфейс. И говорить "достаточно лишь вывода в stdout" можно только от непонимания. Этого достаточно теоретически. Но на практике использовать инструмент будет невозможно, пока Вы сами для себя не создадите аналогичную инфраструктуру (возможность переходить в код, сортировать, фильтровать и так далее).

Популярные статьи по теме
Эффект последней строки

Дата: 31 Май 2014

Автор: Андрей Карпов

Я изучил множество ошибок, возникающих в результате копирования кода. И утверждаю, что чаще всего ошибки допускают в последнем фрагменте однотипного кода. Ранее я не встречал в книгах описания этого …
Зло живёт в функциях сравнения

Дата: 19 Май 2017

Автор: Андрей Карпов

Возможно, читатели помнят мою статью под названием "Эффект последней строки". В ней идёт речь о замеченной мной закономерности: ошибка чаще всего допускается в последней строке однотипных блоков текс…
Технологии, используемые в анализаторе кода PVS-Studio для поиска ошибок и потенциальных уязвимостей

Дата: 21 Ноя 2018

Автор: Андрей Карпов

Краткое описание технологий, используемых в инструменте PVS-Studio, которые позволяют эффективно обнаруживать большое количество паттернов ошибок и потенциальных уязвимостей. Статья описывает реализа…
Бесплатный PVS-Studio для тех, кто развивает открытые проекты

Дата: 22 Дек 2018

Автор: Андрей Карпов

В канун празднования нового 2019 года команда PVS-Studio решила сделать приятный подарок всем контрибьюторам open-source проектов, хостящихся на GitHub, GitLab или Bitbucket. Им предоставляется возмо…
Как и почему статические анализаторы борются с ложными срабатываниями

Дата: 20 Мар 2017

Автор: Андрей Карпов

В своей предыдущей статье я писал, что мне не нравится подход, при котором статические анализаторы кода оцениваются с помощью синтетических тестов. В статье приводился пример, воспринимаемый анализат…
Характеристики анализатора PVS-Studio на примере EFL Core Libraries, 10-15% ложных срабатываний

Дата: 31 Июл 2017

Автор: Андрей Карпов

После большой статьи про проверку операционной системы Tizen мне было задано много вопросов о проценте ложных срабатываний и о плотности ошибок (сколько ошибок PVS-Studio выявляет на 1000 строк кода)…
Статический анализ как часть процесса разработки Unreal Engine

Дата: 27 Июн 2017

Автор: Андрей Карпов

Проект Unreal Engine развивается - добавляется новый код и изменятся уже написанный. Неизбежное следствие развития проекта - появление в коде новых ошибок, которые желательно выявлять как можно раньш…
PVS-Studio ROI

Дата: 30 Янв 2019

Автор: Андрей Карпов

Время от времени нам задают вопрос, какую пользу в денежном эквиваленте получит компания от использования анализатора PVS-Studio. Мы решили оформить ответ в виде статьи и привести таблицы, которые по…
PVS-Studio для Java

Дата: 17 Янв 2019

Автор: Андрей Карпов

В седьмой версии статического анализатора PVS-Studio мы добавили поддержку языка Java. Пришло время немного рассказать, как мы начинали делать поддержку языка Java, что у нас получилось и какие дальн…
Любите статический анализ кода!

Дата: 16 Окт 2017

Автор: Андрей Карпов

Я в шоке от возможностей статического анализа кода, хотя сам участвую в разработке инструмента PVS-Studio. На днях я был искренне удивлён тому, что анализатор оказался умнее и внимательнее меня.

Комментарии (0)

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