Закомментированный код всё равно должен компилироваться
В любой кодовой базе хоть какого-то возраста есть код в комментариях. Отладочная печать, которую кто-то хочет сохранить. Альтернативная реализация, проигравшая бенчмарк, но способная выиграть следующий. Функциональность, отключённая на время релиза, которую, как все клянутся, включат обратно. Совет всегда один — удалить, ведь система контроля версий всё помнит, — и этот совет всегда игнорируют, потому что никто не верит, что сумеет снова найти это в системе контроля версий.
Я хочу предложить нечто отличное от удаления. Код внутри комментария должен разбираться и проверяться языком точно так же, как если бы он был живым, и должен ломать сборку, когда перестаёт иметь смысл.
Что я имею в виду
Особый комментарий, как-то помеченный, чтобы компилятор знал, что внутрь нужно заглянуть:
/*@
log_packet(pkt, sizeof(*pkt));
@*/
Код между маркерами не компилируется в программу. Он не порождает объектного кода, ничего не выполняет, ничего не меняет в бинарнике. Но компилятор разбирает его, разрешает его имена и проверяет его типы относительно окружающей области видимости, и если log_packet переименовали, или pkt здесь больше не виден, или его тип изменился так, что вызов больше не подходит, сборка падает с ошибкой, указывающей на комментарий.
Вот и вся идея. Всё, что язык проверяет в живом коде, он проверяет и в этом. Единственное, чего он не делает, — не генерирует его.
Зачем
Закомментированный код гниёт. Это не вопрос мнения; каждый, кто раскомментировал блок двухлетней давности, знает это ощущение. Половины идентификаторов больше нет. Вызываемая функция обзавелась новым параметром. Структура, которую он обходит, реорганизована. Блок, сохранённый «на случай, если понадобится», в момент, когда он понадобился, оказывается головоломкой, на решение которой уходит больше времени, чем ушло бы на то, чтобы его переписать.
И гниёт он незаметно. Живой код, который устаревает, ломает сборку, поэтому его чинят в тот же день — тот, кто его сломал, кто точно знает, что и зачем он изменил. Мёртвый код в комментарии ломается молча, и поломку обнаруживает кто-то другой, годы спустя, не имея понятия, что изменилось за это время.
Проблема не в стоимости сопровождения. Проблема в том, когда эта стоимость платится. Поддерживать блок закомментированного кода в согласии с окружающим кодом — по одной небольшой правке за раз, по мере того как меняется окружение, — дёшево: переименование здесь, параметр там, и всё это делает человек, вносящий изменение, пока оно у него в голове. Проделать всё это сопровождение разом, позже, без контекста — дорого, и часто это просто бросают. Проверяемые комментарии переносят затраты с дорогого момента на дешёвый.
Возражение
Очевидный ответ: это превращает закомментированный код в обузу — теперь я не могу ничего закомментировать, не поддерживая его корректным вечно.
Да. В этом и смысл. Либо код стоит сохранять — и тогда его стоит сохранять корректным, — либо не стоит, и тогда правильным ходом был тот, который все рекомендуют и никто не делает, — удалить его. Проверяемый комментарий заставляет сделать честный выбор. Непроверяемый позволяет выбора избежать, и результат такого уклонения — кладбище, которое есть в каждом старом проекте.
Здесь есть реальная цена — в случае большого блока, который хранят для справки, а не для повторного использования, когда корректность относительно текущего кода вам не нужна. Для этого случая обычный комментарий никуда не делся. Никто не предлагает его убрать. Проверяемый комментарий — дополнительный инструмент для конкретного случая кода, который должен вернуться.
Что для этого нужно
В большинстве языков — немного. Парсер и так должен находить конец комментария; найти маркер внутри него — небольшое расширение. Затем проверяемый блок разбирается как список операторов или список объявлений в той области видимости, где находится комментарий, с тем же разрешением имён и той же проверкой типов, что и живой код, а потом отбрасывается до генерации кода. Языки с препроцессором могли бы сделать грубую версию через #if 0, и некоторые так и делают, но блоки #if 0 не разбираются, а именно этого и не хватает.
Несколько языков бродили неподалёку. Примеры в документационных комментариях, которые компилируются и запускаются как тесты, — тот же инстинкт, применённый к документации: пример в комментарии должен продолжать работать, иначе сборка падает. То, что описываю я, — тот же инстинкт, применённый к коду, который вы собирались оставить мёртвым.
Общий принцип
Всё, что вы храните, должно храниться истинным, а дешевле всего поддерживать что-то истинным непрерывно. Любой механизм, позволяющий чему-то молча уплыть из корректности, — будь то комментарий, конфигурационный файл, который никто не проверяет, или документ, который никто не пересобирает, — это механизм превращения серии мелких дешёвых исправлений в одно крупное и дорогое в самый неподходящий момент.
Компиляторы очень хорошо умеют отказываться принимать то, что неправильно. Нам стоит позволить им отказываться чаще.