Как бороться с большим количеством комментариев FIXME / TODO

Question

В настоящее время работает над проектом, который довольно стар и содержит множество комментариев FIXME / TODO. Мне было интересно, если есть хороший способ справиться с этим.

В качестве первых шагов я предполагаю, что было бы неплохо получить видимость, поэтому конвертируем их в тикеты. Во время этого преобразования, возможно, некоторые комментарии могут быть удалены, поскольку проблемы, на которые они указывают, были решены, но удаление комментария было забыто.

На втором шаге активируется прерыватель FIXME / TODO в конвейере сборкипоэтому новые не создаются.

Но теперь - каков наилучший путь / каковы наилучшие способы продолжить отсюда?

Answer 1

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

Перенос FIXME / TODO в тикеты только переносит проблему на другой уровень. Когда FIXME очевиден и представляет явную ошибку, создание заявки, в этом случае, необходимо. То же самое с TODO.

Простого решения не существует, но я думаю, что необходимо выполнить два шага:

1. Решить, что делать с текущим FIXME / TODOS : что делатьс текущим FIXME / TODOS всегда будет зависеть, а иногда и от делового решения, из-за времени и ресурсов, которые вам понадобятся для его решения. Вы можете решить, удалить это или проанализировать это один за другим и решить, что делать с каждым случаем. Если вы решили проанализировать его, вы можете найти и заменить FIXME на OLD_FIXME и TODO на OLD_TODO и открыть путь для правильного использования нового FIXME / TODO.
2. Начните правильно использовать FIXME / TODOS. : Не разрешать код с FIXME / TODOS. Добавьте этап проверки кода в процесс разработки, и когда кто-то добавляет эту инструкцию, решение должно быть принято до того, как код станет основным.