Удалите TODO, stop using them за все, что не является краткосрочным (для длины билета или вилки) и переместите их в билеты на систему отслеживания билетов.
TODO комментарии есть несколько проблем: -
они могут быть трудно найти, если вы используете IDE, который не автоматически локализовать их. (Я знаю Devs, которые используют возвышенное или даже Emacs, поэтому потребуется конкретный поиск)
, чья работа заключается в поиске и устранении этих проблем?
Как тратить время на их отслеживание?
они могут устареть, как и большинство комментариев. Если кто-то исправляет проблему без чтения TODO и оставляет ее там, это вызывает путаницу. Если другое исправление непреднамеренно исправляет его, комментарий остается неосознанным.
У вас теперь есть две системы отслеживания проблем, одна из внутренней документации и одна в любой системе отслеживания проблем, которую вы используете.
Если вы пишете TODO, тогда вы являетесь тем человеком, у которого есть знания, чтобы исправить это. Кто-то, кто придет позже, должен будет исправить это на основе очень короткого комментария без описания.
Там нет ничего более раздражающего, чем кусок кода разработчиком, который был слишком ленив, чтобы сделать хорошую работу, поэтому оставил его на следующий парень
или тот, кто WASN» т ленивый, но был слишком напуган, чтобы сломать что-то и просто в конечном итоге сделать проблему более сложным с минимальными комментариями предполагая, что есть проблема
