TODO

Материал из Seo Wiki - Поисковая Оптимизация и Программирование

Перейти к: навигация, поиск

TODO (от англ. to do, сделать) — распространённый тип пометки в комментариях исходных текстов программ, документации и т.д., показывающий разработчику место, где следует продолжить работу (исправить ошибку или неточность, добавить функциональность, учесть какой-то специфичный случай и т.д.).[1]

Распространённость пометки такова, что многие программы подсветки синтаксиса выделяют TODO (обычно большими буквами). Также использование TODO является стандартом оформления кода на Object Pascal, Delphi[2].

Программное обеспечение, поддерживающее TODO:

Критика

Использование TODO в коде внесено[кем?] в список анти-паттернов[9][неавторитетный источник?] в связи с тем, что поиск TODO в коде доставляет программисту много затруднений, часто места с TODO пропускаются и/или игнорируются из-за своей неочевидности, комментарии часто не успевают за кодом (т.е. сохраняется TODO, актуальное для старого кода); нет возможности определить (формально) приоритет места, где нужны изменения. Вместо TODO в комментариях, рекомендуется использовать багтрекер или базу задач[1].

Примечания

  1. 1,0 1,1 http://www.approxion.com/?p=39 TODO or not TODO
  2. Стандарт стилевого оформления исходного кода DELPHI (рус.) (5 июня 2003). Проверено 28 ноября 2009.
  3. (ссылка на исходные тексты [1])
  4. http://sourceforge.net/projects/gedit-todo/
  5. В файле common.jar (lib/default.hrc) - подсветка <regexp region="TODO" priority='low'>/\b((FIXME|TODO|BUG|FIX)\b.*$)/xi</regexp> (архив исходных текстов [2])
  6. Поддержка TODO, FIXME, BUG в vim (англ.)
  7. TODO и FIXME в emacs (англ.)
  8. О поддержке токенов TODO, HACK, UNDONE в Visual Studio (англ.)
  9. http://c2.com/cgi/wiki?TodoCommentsConsideredHarmful

См. также

  • FIXME - аналогичное высказывание об ошибочном месте, требующем исправления.
Источник — «http://www.sbup.com/wiki/TODO»
Личные инструменты

Served in 0.144 secs.