А как вы разделяете важность TODO в коде?

Вопрос чисто теоретический, но мне интересно как это делают приличные люди, а не я. Все мы в коде так или иначе используем аннотации TODO, DEPRECATED и прочее. Но хотелось бы как-то разделять те же TODO по степени важности. Например: обычные, важные, очень важные TODO.

Логичной выглядит система использования каких-либо постфиксов. То есть «TODO что-то-там». Но никаких мыслей насчет унификации такого подхода у меня так и не родилось.

Может есть уже готовые, более менее стандартизованные и принятые многими (а значит и поддерживаемые в IDE) обозначения.
  • Вопрос задан
  • 11276 просмотров
Пригласить эксперта
Ответы на вопрос 5
EugeneOZ
@EugeneOZ
TODO должны быть не в коде, а трекере задач, где есть приоритезация. К TODO в коде отношусь отрицательно.
Ответ написан
Gluttton
@Gluttton
// FIXME: Implement this.
// TODO: Enhance this comment.
// INFO: Let it be…
// HACK: I don't know why, but this works.
// WTF: How is it possible?

IDE и здравый разум в основном парсят первые три.
Ответ написан
Комментировать
@kuaw26
// FIXME что-то там — для TODO которые надо починить в ближайшее время
// XXX что-то там — «порнографическая» залепа :)
// TODO что-там — просто планы на будущее
Ответ написан
Комментировать
ZaiSL
@ZaiSL
Наиболее востребованные пометки в коде — это участки, требующие рефакторинга и куски, где временно убрана проверка/подставлено значение/что-то закомменчено на время разработки и т п.

В связи с этим, два дополнительных типа:
— REF — refactoring
— IMP — importance

//@todo REF Это нужно отрефакторить
//@todo IMP Вернуть проверку перед деплоем

По поводу поддержки IDE. Например, в моём phpStorm такие todo отображаются в специальной панельке. Плюс ко всему, есть возможность по шаблону задать разные цвета текста для того или иного типа.
Рекомендую ;)
Ответ написан
@egorinsk
Если у вас так много TODO, может стоит лучше провести неделю закрытия туду вместо их категоризации?
Ответ написан
Ваш ответ на вопрос

Войдите, чтобы написать ответ

Войти через центр авторизации
Похожие вопросы