Страницы

Поиск по вопросам

понедельник, 8 октября 2018 г.

Как правильно помечать костыли в коде?

Зачастую при любой разработке возникает необходимость написать код, про который известно заранее что он:
Крайне не гибок. Или.. Может вызвать баги, проблемы в дальнейшем. Или.. Совершенно не читаем.
Или такой код достаётся по наследству, и хочется пометить места, которые надо затем выправить. Такой код называется по-русски костыль. К сожалению на англоязычных сайтах трудно найти информацию об этом, так как у них термин "костыль" - отсутствует в принципе. Рекомендуют переводить, как "kludge" - но это не часто понимают.
Вопрос - как помечать костыли в коде комментариями, чтобы было просто составить список из всех костылей в проекте, и крайне желательно - чтобы была их обозримость в IDE, может даже расстановка приоритетов? Меня больше интересует PhpStorm, но другим будет интересно узнать про их IDE.
P.S. Есть конечно спец-метка в комментах TODO, но хотелось бы представлять костыли и TODO отдельно друг от друга, всё таки они сильно разные по сути. Поэтому некоторые договариваются о специальных комментах вроде:
/* TRASHCODE {why below code is bad} */ ... /* TRASHCODE end*/
Потом по коду выискать просто, но помощи IDE в обозрении костылей в таком случае нет.


Ответ

хотелось бы представлять костыли и TODO отдельно друг от друга
Во-первых, все приличные IDE кроме TODO понимают "из коробки" ещё и FIXME
но помощи IDE в обозрении костылей в таком случае нет
Во-вторых, все приличные IDE :) умеют добавлять пользовательские таск-теги.
PhpStorm (и любые другие джетбрейновские):

Eclipse (можно кастомизировать даже для каждого языка/проекта):

для FIXME и TODO - можно обозначать конец? То есть выделить с помощью комментов блок.
Насколько понимаю - нет, везде отслеживается только одна строка с ключевым словом. Максимум что можно - кликнуть по ней в соответствующей закладке и перейти к этому месту в исходнике.
CLion

В закладке:

Eclipse

В закладке:

Комментариев нет:

Отправить комментарий