Как известно, IDE поддерживают такие типы комментариев, как TODO, FIXME
Они хороши тем, что можно автоматически собрать и посмотреть их в списке, а также выделением цветом
В какой-то момент я заметил, что если оставляю в коде закоментированный код, то наряду с ним комментарии, описывающие, что происходит в коде теряются и становятся сложно читаемыми
Тогда я добавил в IDE тип комментария, начинающийся с DO, чтобы он подсвечивался немного другим оттенком серого, и так их теперь легко отличить от закоментированного кода и можно быстро просмотреть, что происходит внутри метода
Конечно, лучше не комментировать код, а выделять каждый кусок в отдельный метод и названия вызываемых методов должны быть самокомментирующими, но думаю, что и этот метод может быть полезен на некотором этапе развития
А сделать это в IDE PHPStorm можно следующим методом:
Меню -> Preferences -> Editor -> TODO -> Patterns -> создаем новый шаблон и выставляем необходимые нам настройки. Я поставил себе немного более тёмно-серый с примесью синего цвет, который не слишком яркий, но при этом читаемый, и явно отличается по цвету от остальных обычных комментариев на слово DO без учёта регистра