Возможно, вам нужен не TODO

Если вы хотите отметить кусок кода как неидеальный — не обязательно писать TODO. Есть и другие ключевые слова и возможно они буду иметь большой смысл в вашей ситуации.

  • NOTE — Пояснение к коду, который работает.
  • HACK — Пояснение к коду, который использует неочевидное поведение. Обычно комбинируется с FIXME.
  • FIXME — Просьба к абстрактному разработчику из будущего исправить код. Обычно используется в MVP и прототипах.
  • BUG — Описание реальной проблемы в коде. Подходит для ситуаций, когда вы точно знаете о каком–то граничном случае, который скорее всего не должен произойти при реальном использовании.
  • TODO — Просьба к разработчику из будущего дописать что–то. В отличии от FIXME, код должен быть полностью рабочим.
  • STOPSHIP — Описание критической проблемы, которая блокирует выпуск продукта. Для блокировки выпуска удобно использовать checode в CI/CD конвейере.

Комментарий должен быть написан на отдельной строке. Если для описания требуется более одной строки, стоит вынести главную мысль в первую строку и сделать её законченным предложением. Это упростит дальнейший поиск и ускорит понимание.