Как часто вы видите «todos» в своем коде? Я вижу их много.
Когда вы пытаетесь понять устаревший код, вы читаете его строчка за строчкой. Если бы вы нашли какую-то странную логику, вы бы попытались найти ей какое-то объяснение в todos. Тем не менее, вы не можете в большинстве случаев.

Почему это происходит?

Я думаю, что мы так непонятно пишем todos. В общем, «todos» может помочь вам и вашим коллегам в будущем найти эти кейсы.
А вы думали о том, как их написать?

В общих случаях это выглядит примерно так:

/**
 * todo: Remove next line
 */
const uselessVariable = ‘useless’;

Аааа... Это выглядит полезным?

Я думаю, что нет.

Это «задание» бесполезно, потому что оно не имеет контекста.

  1. Кто его создал?
  2. Почему это было написано?
  3. Когда вы сможете удалить его?

Чтобы это «дело» было полезным, я бы предложил этот вариант.

/**
 * @todo: madmed677
 *
 * We should increase value by one because module "my-module"
 *  was imperative and it tries to read variable "count"
 *  and if it undefined module throws an exception
 *
 * The task to change this imperative module to declarative - {link}
 */

Да, он выглядит намного больше, чем предыдущий комментарий. Но это может помочь вам и вашим колледжам. Теперь мы понимаем, кто его создал (даже если кто-то внес изменения в git), зачем он был создан и в какой задаче он будет исправлен.

И причина «Почему это было написано?» очень важна. Если разработчик не может объяснить «почему» или привести убедительную причину, вы можете немедленно ответить на проверку кода и предотвратить это действие. Тем не менее, вы должны попросить разработчика решить проблему немедленно.

Если у вас есть другое мнение, оставляйте свои комментарии, обсудим.