четверг, 7 мая 2015 г.

Что делать если нужно найти дубликаты в коде C# \ VB.NET?


На работе мне поставили задачу изучить иходный код приложения и вынести вердикт по его качеству. 
Код, как положено, старый и написаный специалистами не-.NET технологий. Качество, естественно, страдает (а покажите мне двух программистов, которые не найдут за что покритиковать код друг друга). Качество кода имеет несколько характеристик и, может быть описано в формально с помощью метрик. Одна из метрик, которую я выбрал для анализа - количество дубликатов в коде. Возник вопрос как сделать поиск дубликатов в коде и какие инструменты для этого использовать? Особенно удачно поиск дубликатов реализован в TeamCity  в одном из стандартных билд шагов. Именно такой поиск дубликатов и нужен был. 
Поиск по интернетам навел меня на запись в блоге JetBrains про ReSharper Command Line Tools - бесплатный набор полезных дополнений к ReSharper'у. Этот набор утилит был выпущен вместе с ReSharper 8 и неплохо его дополняет. 
Общий синтаксис запуска утилиты:
dupFinder [OPTIONS] source
В качестве источника для анализа можно указать как C# так и VB файлы. Для анализа можно указать файлы проекта *.csproj \ *.vbproj, файлы решения *.sln, непосредственно файлы с кодом *.cs \ *.vb и путь (как относительный так и абсолютный) к директории в которой находятся файлы с исходным кодом.

Опций для запуска утилиты достаточно много, остановлюсь на самых важных, на мой взгляд.

  • /help - ключ, который покажет список доступных параметров запуска
  • /config - для указания пути к файлу с настройками запуска утилиты. Удобно для многократного запуска или в случае если нужно иногда менять настройки без изменения аргументов командной строки
  • /config-create - этот ключ создает файл конфигурации с аргументами заданными при запуске. Может быть удобно для создания первичной конфигурации с последющим ее редактированием в текстовом редакторе.
  • /exclude - исключает поиск дубликатов в указанных файлах. Файлы могут быть заданы с помощью wild-cards. Путь к исключенным файлам может быть как абсолютным так и относительным
  • /discard-fields, /discard-literals, /discard-local-vars, /discard-types - исключить из анализа одинаковые строки в которых используются разные поля, литералы, локальные переменные и классы. Если 2 класса содержат одинаковый набор строк и при это имеют разные названия, они тоже будут исключены из рассмотрения. По умолчанию все эти опции отключены.
  • /discard-cost - не рассматривать код как дубликат, если сложность кода меньше определенного порога. Этой опцией можно задать такой порог (значение по умолчанию - 70). Если посчитанное значение Code Complexity будет неже указанного значения, код не будет считаться дубликатом. Опция может быть удобна для случаев, когда много раз повторяется одинаковая строка, например Assert.AreEqual(targetValue, "true"); Значение сложности стоит подбирать эмпирически для каждого проекта
  • /show-text - показывать в отчете дублирующиеся строки
  • /output - путь к файлу, куда будет сохранены результаты работы утилиты
Пример запуска утилиты для анализа дубликатов:
dupFinder.exe /discard-literals=true /o="report.xml" /discard-cost=50 "C:\src\MySolution.sln"

1 комментарий: