У нас есть приложение, которое велико, и мы добавили правило TODO к воротам качества, которое выдает ошибку, если обнаружены комментарии TODO. Если мы просто удалим комментарий TODO (что пугает), он сработает, но вся цель добавления комментария TODO будет потеряна. Есть ли еще способ сохранить комментарий TODO, добавив что-нибудь еще, каким образом мы можем отложить задачу TODO? (Например, это гигантская задача).
Как обрабатывать комментарии TODO при обнаружении ошибки сонара
Ответы (1)
Удалите TODO, прекратите использовать их для всего, что не является краткосрочным (на время тикета или вилки) и переместите их в билеты в вашей системе отслеживания билетов.
Комментарии TODO имеют несколько проблем: -
их может быть трудно найти, если вы используете IDE, которая не находит их автоматически. (Я знаю разработчиков, которые используют Sublime или даже Emacs, поэтому потребуется конкретный поиск)
чья работа - находить и исправлять их?
как отслеживается время, потраченное на них?
они могут устареть, как и большинство комментариев. Если кто-то устранит проблему, не читая TODO, и оставит ее там, это вызовет путаницу. Если другое исправление непреднамеренно исправляет это, комментарий по незнанию остается там.
Теперь у вас есть две системы отслеживания проблем: одна для внутренней документации, а другая - для любой системы отслеживания проблем, которую вы используете.
Если вы пишете TODO, то вы тот самый человек, который знает, как это исправить. Кто-то, кто придет позже, должен будет исправить это на основе очень короткого комментария без описания.
Нет ничего более раздражающего, чем фрагмент кода разработчика, который был слишком ленив, чтобы сделать хорошую работу, поэтому оставил это следующему парню.
или тот, кто не был ленив, но был слишком напуган, чтобы что-то сломать, и просто усложнил проблему с минимальными комментариями, предполагающими, что проблема есть
person
Ross Drew
schedule
05.01.2016
