Откуда берется конвенция TODO? - PullRequest
11 голосов
/ 29 февраля 2012

Я подозреваю, что этот вопрос задавался ранее, но Google не легко для этого.

Я довольно новый кодер, и я вижу много кода на разных языках, с комментариями, начинающимися с "TODO".

Вопросы:

  • Есть ли практическая причина, по которой люди пишут TODO на всех этих разных языках, или это просто соглашение?
  • Если последнее, гдеоткуда взялась эта конвенция?

Я понимаю, почему полезно иметь возможность искать TODO, мне просто любопытно, какая история стоит за ним.

Ответы [ 5 ]

4 голосов
/ 29 февраля 2012

Программирование - это деятельность по всему миру;соглашения, помогающие сгладить процесс работы с людьми, которые не являются носителями языков друг друга, на вес золота.TODO и XXX часто выделяются IDE, что дает отличный стимул придерживаться этих опций.

XXX предполагает опасность или опасность, о которых должны знать программисты по обслуживанию;TODO объясняет недостатки, которые было бы неплохо устранить.

2 голосов
/ 25 апреля 2017

Просто быстрое продолжение исходного ответа: Эта функция в основном является справочной, и вы найдете ее в Frameworks, если есть элементы, которые не наносят ущерба коду, все еще работающему, но к которому разработчики хотели бы обратиться.

Приятная вещь в современных IDE, например, я использую JetBrains PHPStorm, они фактически выделяют TODO и помещают их в панель инструментов для всего вашего проекта, чтобы вы могли видеть все TODO для всех ваших файлов, различая их каталог и имя файла.

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

2 голосов
/ 29 февраля 2012

ТОДО означает «делать».То, что кому-то понадобится , чтобы сделать .Просто предположение, но может ли это предположение быть неправильным?

0 голосов
/ 05 июня 2019

Вот хорошая информативная статья о соглашении TODO

https://medium.com/imdoneio/5-ways-using-todo-comments-will-make-you-a-better-programmer-240abd00d9e4

Особое выделение из статьи:

СохранитьВаша команда обновляется, не оставляя код:

Если вы попробовали imdone, вы будете знать, что комментарии TODO могут создавать обновления и закрывать проблемы GitHub.Допустим, у вас есть комментарий, который выглядит следующим образом ...

// TODO: завершите проверку контроллера + рутинная работа Если вы запускаете imdone-atom, он будет поднят и будет создана проблема GitHub.

// TODO: завершить проверку контроллера + идентификатор задачи: 8 gh: 4 Когда вы закончите с этим заданием, просто измените токен на DONE.

// DONE: завершите проверку контроллера + работаid: 8 gh: 4 Теперь проблема с GitHub будет закрыта.Когда вы будете готовы зафиксировать свой код, просто удалите комментарий, используя доску imdone.Я уверен, что вы не пропустите возможность отвлекаться, переключаясь в окно браузера каждый раз, когда вам нужно обновить проблему.

0 голосов
/ 01 июня 2017

Например, , это первый стандарт языка Python: Мнемоника .

...