Я подозреваю, что этот вопрос задавали раньше, но это нелегко для Google.
Я довольно новый кодер, и я вижу много кода на разных языках с комментариями, начинающимися с "TODO".
Вопросы:
Я могу понять, почему это полезно, чтобы иметь возможность grep для TODO, мне просто интересно узнать об истории.
Программирование - это всемирная деятельность; соглашения, призванные помочь сгладить процесс работы с людьми, которые не являются носителями языка друг друга, стоят своего веса в золоте. TODO и XXX часто выделяются IDE, что обеспечивает отличный стимул придерживаться этих параметров.
XXX указывает на опасность или опасность, о которых должны знать специалисты по программированию; TODO объясняет недостатки, которые было бы неплохо адресовать.
TODO означает "делать". Что-то, что кому-то понадобится сделать. Просто гадать, но может ли это догадаться неправильно?
Просто следуйте первоначальному ответу: Эта функция в основном является ссылкой, и вы найдете ее в Frameworks, если есть элементы, которые не наносят ущерба коду, все еще запущенному, но что разработчики хотели бы адресовать.
Хорошая вещь о современных IDE, например, я использую JetBrains PHPStorm, они на самом деле highlifht TODO и помещают их в панель инструментов для всего вашего проекта, чтобы вы могли видеть все TODO для всех ваших файлов, дифференцированных по их каталогу и имени файла.
В любом случае, просто подумайте, что это может добавить дополнительный свет о том, почему вы можете увидеть его на протяжении всего кода.
Например,, это первый в употреблении стандарт языка Python: Mnemonics.
Вот хорошая информативная статья о конвенции TODO
Особая изюминка из статьи:
Держите свою команду в курсе, не выходя из кода:
Если вы попробовали imdone, вы знаете, что комментарии TODO могут создавать обновления и закрывать проблемы GitHub. Допустим, у вас есть комментарий, который выглядит следующим образом...
//TODO: завершить проверку контроллера +chore Если вы запускаете imdone-atom, он будет поднят и возникнет проблема с GitHub.
//TODO: завершить проверку контроллера +chore id: 8 gh: 4 Когда вы закончите с этим заданием, просто измените токен на DONE.
//ВЫПОЛНЕНО: завершите проверку контроллера +chore id: 8 gh: 4 Теперь проблема GitHub будет закрыта. Когда вы будете готовы зафиксировать свой код, просто удалите комментарий, используя доску imdone. Я уверен, что вы не пропустите отвлекаться, переключаясь в окно браузера каждый раз, когда вам нужно обновить проблему.