Подтвердить что ты не робот

Как управлять программным обеспечением @todo?

На протяжении многих лет мой код был заполнен такими комментариями:

//TODO : Add ...
...
/*
 *TODO : Fix ...
 *
 */

Теперь я думаю создать собственную @todo аннотацию javadoc... но прежде чем делать это, я хочу знать, есть ли у вас, ребята, лучший способ управлять вашими материалами программирования todo?

4b9b3361

Ответ 1

В вашей среде IDE (Eclipse, NetBeans,..) есть плагин задач, который обнаруживает все TODO и показывает их в списке. В Eclipse это Window > Show View > Other > Tasks

Не нужно писать собственные аннотации.

Ответ 2

Операторы TODO несут риск остаться в коде навсегда, что плохо, потому что // TODO elaborate answer

Ответ 3

В основном я использую три системы для разных видов предметов TODO:

  • Бумажный блокнот для краткосрочных товаров (например, сегодня или на этой неделе).
  • Комментарии TODO плюс поддержка IDE (например, просмотр задач Eclipse) для более мелких и долгосрочных элементов
  • Трекер ошибок, такой как поддержка Trac plus IDE (например, Mylyn) для более сложных долгосрочных элементов

Ответ 4

Для vim существует также Tasklist script, вдохновленный списком задач Eclipse, который сбрасывает TODO, FIXME и т.д. в вашем текстовые файлы и отображает их как список в дополнительном буфере (см. снимок экрана).

Ответ 5

Может быть, Doxygen может вам помочь?

Doxygen распознает те /// @TODO: s и создает с ними список.

И поскольку Doxygen может использовать комментарии в стиле Javadoc, я думаю, что это легко попробовать.

Ответ 6

Я бы не использовал аннотацию @todo javadoc, потому что IMO он не должен входить в документацию.
Документация должна быть общедоступной, а не идеальной для TODO.
TODO также должны приближаться к коду, к которому они относятся, преимущество использования комментариев.

Ответ 7

Для небольших задач, таких как мой обычный //todo, я использую локальные задачи в Eclipse Mylyn для больших задач (даже если я думаю, что их можно назвать функциями или ошибками), я использую Trac; если вы найдете свой код, полный TODOs, время для получения системы управления билетами.

Ответ 8

Возможно, вы можете использовать find и grep для поиска этих ключевых слов в своих проектах

Ответ 9

проблема с флажками todo такая же, как с предупреждениями (например, java-компилятор, checkstyle). если они появятся часто, вы проигнорируете их. в вашем случае я бы отслеживал их через отчет сборной системы (например, maven или ant). в конце каждой итерации вы должны сделать правило, что количество флажков todo уменьшается.

меньше todo-flags означает:

  • решение их
  • удалите их, потому что они устарели (что часто случается, если вы никогда не убираете код)

обычно не используют флаги todo для всех задач. для меня это всего лишь небольшие напоминания или рефакторинг-тодо. большие задачи всегда должны отслеживаться системой билета (например, trac или jira).

Ответ 10

Я использую FIX! вместо TODO. Количество восклицательных знаков указывает на приоритет. IntelliJ позволяет настраивать для них настраиваемые фильтры, поэтому я могу посмотреть на уровень 3 "FIX!!!" комментарии и решения этих проблем.

Ответ 11

Если вы используете Maven, вы можете использовать taglist-maven-plugin для сканирования исходных файлов для тегов (любой тег, который вы хотите, этот настраивается) и генерирует отчет о своих встречах.

Плагин Taglist Maven генерирует отчет по различным тегам найденный в коде, например @todo или //TODO теги

Но теги отслеживания - легкая часть, их исправление немного сложнее и занимает больше времени:)

Ответ 12

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

Ответ 13

TODO отлично подходит для небольшой команды, но если вы используете проект с открытым исходным кодом или каким-либо образом расширяете доступ разработчика, другие варианты, такие как TO_DO, fixme, XXX, NOTE, HACK, bug, "your_defect_tool_here" и т.д. сканирование в любом случае. Немного тяжелый, но мой TODO-протокол будет выглядеть так:

TODO: уу-мм-дд: автор: your_comment

Наконец, сделайте комментарий, который вы оставляете стратегическим, а не конструкторским выражением или мнением.