- PVSM.RU - https://www.pvsm.ru -
Обзор кода полезен и делать его можно разными способами: патчами по почте, сидя рядом лицом к лицу или используя специализированные инструменты/плагины. Каждый способ имеет свои плюсы и минусы, однако мы предлагаем ещё один, который позволяет нам использовать то, что у нас уже есть.
Метод будет интересен небольшой команде, использующей распределённую систему контроля версий (git, mercurial, bazaar) с внедренной методологией разработки фич/задач/багов в ветках (например, gitflow). Редакторы кода в команде поддерживают парсинг комментариев на предмет определённых ключевых слов (например, TODO). А полнофункциональные специализированные инструменты для обзора кода не могут быть внедрены, так как платны и не имеют строки в бюджете; либо бесплатны, но не просты в установке или имеют сомнительное удобство использования; или же в конкретном случае могут быть воробейной царь-пушкой.
Общая идея — фичи (баги, таски) разрабатываются в отдельных ветках, а-ля gitflow, а затем публикуются на некий сервер — можно даже центральный. Рецензент пишет комментарии в стиле TODO, но с особым тегом, например «REV»:
$ourcoolcode = 123;
// REV Что это тут у нас такое?
echo $ourcoolcode;
/**
* $TAG $status $title
* $commentor1 $comments
* $commentorN $comments
*/
Комментарии могут быть как однострочными, так и многострочными, что зависит от конкретного языка.
Любая современная IDE умеет экстрактить и фильтровать TODO. Это точно умеет Eclipse и Netbeans, а JetBrains и прочие платные редакторы просто обязаны это делать. В итоге можно меняться комментами в ветке, пока всё не станет ясно и они не кончатся. По окончании процесса, когда код станет лучше, ветку можно смело сжимать (squash) и вливать (merge) в основную (develop). Все комменты по окончании стираются и не должны попасть в код, что можно зафорсить хуками.
Подчеркнем, что данный метод не предлагается, как единый и самый правильный, а является одним из вариантов в определённых условиях. Если вы знаете или уже использовали что-то подобное, но не формализировали, то опишите смело, также приветствуются улучшения метода. Даже если данный способ не подойдет вам, то возможно он натолкнет вас на какие-то иные идеи.
Автор: garex
Сайт-источник PVSM.RU: https://www.pvsm.ru
Путь до страницы источника: https://www.pvsm.ru/razrabotka/17202
Нажмите здесь для печати.