Редактор кода Visual Studio

Мое любимое расширение VS Code

Выявляйте и улучшайте чрезмерно сложный код с помощью Tech Debt Tracker

Никто не любит технический долг, поэтому я люблю Tech Debt Tracker for VSCode. Он не только отлично справляется с выявлением технического долга в вашем существующем коде, но и может уберечь вас от накопления еще большего долга. Это поощряет то, что Мартин Фаулер называет оппортунистическим рефакторингом. В нем есть некоторые инструменты для совместной работы, которые я еще не изучил, но полезно просто выявить технический долг. Инструмент присваивает вашему коду рейтинг от А (хорошо) до Е (ужасно). Оценка A означает, что этот код чист, прост в обслуживании и, скорее всего, не содержит ошибок. Кто этого не хочет?

Я использовал этот инструмент в течение нескольких месяцев разработки TypeScript и пришел к выводу, что используемые метрики ценны и точны. Я редко не согласен с результатами. Говоря о результатах, они разбиты на несколько категорий, таких как глубина вложенности, понятность, количество аргументов и некоторые другие. Вы можете увидеть детали в своем редакторе и принять решение о том, что важно исправить. В проводнике также есть панель Рейтинги долга, чтобы вы могли получить обзор рейтингов всех методов в файле.

Развитие с нуля

Если вам посчастливилось писать код в совершенно новом проекте, просто используйте этот инструмент для мониторинга разработки кода и стремитесь сделать каждый метод на «отлично». В пылу битвы можно кодировать «B» или «C». Но перед релизом проведите рефакторинг с целью A для всего. Если по какой-то причине вы не можете, решите, является ли это `//TODO` или `//FIX` на будущее или, по крайней мере, примечанием о том, почему вы оставили его не в первозданном виде. Иногда метрика комментариев может мешать.

Правило скаута

Вы всегда должны оставлять свой код чище, чем вы его нашли. Когда вам нужно поработать над методом, а оценка Tech Debt Tracker падает, вы должны исправить код, чтобы он был не хуже, чем в начале. Если это не было пятеркой, когда вы начинали, вы могли бы подумать о том, чтобы сделать будущему одолжение и сделать это пятеркой, прежде чем считать, что вы закончили.

Целевой рефакторинг

Tech Debt Tracker также можно использовать для сортировки работ по рефакторингу. Просмотрите кодовую базу и найдите код с худшими оценками. Я хотел бы, чтобы инструмент автоматически находил худший код, но на данный момент он недоступен.

Иди без эго

Оставьте свое эго в безопасном месте и попробуйте. У меня было много кода, который не получил «А». Иногда мне казалось, что инструмент сумасшедший, но я все равно провел рефакторинг. Почти во всех случаях, когда я заканчивал, мне приходилось признавать, что мой код улучшился. В (очень) немногих случаях, когда я не считал код более понятным, я просто возвращался к исходному коду. Я понял, что после 40 лет работы у меня появились некоторые инстинкты, которым я мог доверять.

Мы вот-вот вступим в 2022 год, и я все еще люблю этот инструмент. Вы можете прочитать больше моих статей о Visual Studio Code
Пишите спокойно.