Почему все пишут комментарии к заглавным буквам? [закрыто]

9

Я делаю то же самое. Когда в моем коде есть что-то «делающее», я пишу //TODO .... Но мне любопытно узнать, когда это началось и есть ли причина для написания «дел» прописными буквами?

Мохсен
источник
20
Потому что мы действительно ЗНАЧИМ ЭТО (мы просто никогда не обходимся с этим)
Энтони Пеграм
3
чтобы редакторы могли пометить их и позволить вам искать их (например, список задач Eclipse)
ratchet freak
6
Поскольку вы не можете сделать текст жирным внутри кода, вам нужен какой-то способ выделить важные вещи. Отсюда ...
Карлсон
4
Почему это имеет значение?
Ладья
3
Я пишу//todo:...
BЈовић

Ответы:

23

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

«todo» (нижний регистр) потенциально может быть частью большего слова / функции / переменной, но «TODO» (верхний регистр), вероятно, не будет.

Баттл Буткус
источник
4
Это также позволяет редакторам выделить это. Например, Gedit делает это только для всех заглавных букв TODO. Какой бы ни была причина, для меня достаточно стимула писать это прописными буквами.
4
@delnan: Это тавтология. Это было сделано, чтобы выделиться, чтобы люди использовали его, поэтому кто-то добавил подсветку синтаксиса в vim, чтобы выделиться больше, чтобы люди использовали его, чтобы выделиться. Люди не используют это, потому что редактор выделяет их, они используют это, потому что это обычно делают, и таким образом редактор выделяет это. Вы можете выделить в vim все, что угодно, просто измените подсветку синтаксиса соответствующим образом, так же легко todoвыделить, но в этом нет особого смысла, так как принято использовать TODO.
Мартин Йорк,
1
@LokiAstari: Как я уже сказал, я пишу его прописными буквами, потому что больше редакторов выделяют это по умолчанию. Но, возможно, я исключение: довольно молодой (так что я не смог бы сделать это до того, как редакторы поддержали его) и (к сожалению) слишком много капризов и ленивых задниц, чтобы вручную настроить подсветку синтаксиса.
Также хорошо для бедного парня, который должен убирать за вами, и для всех, кому нужно просмотреть ваш код, прежде чем он будет завершен. Они могут сразу увидеть, что еще не сделано из-за этого соглашения.
sq33G
2
Я встречал TODO в смешанном регистре с именем переменной, как filesToDownload. Конечно, поиск «только целых слов» решает эту проблему.
Ден04
8

Мне любопытно узнать, когда это началось, и есть ли причина для того, чтобы написать все капиталы?

Идея с комментариями типа TODO и FIXME состоит в том, чтобы заставить их выделиться. Как правило, вы не хотите отправлять код с такими маркерами в коде - они отмечают, что нужно сделать, прежде чем проект можно будет считать завершенным. Использование ALL CAPS делает их немного легче, если вы не используете ALL CAPS для многих других вещей в вашем коде тоже.

Калеб
источник
5

И Eclipse, и Visual Studio имеют функции списка задач, которые автоматически предоставляют вам списки строк комментариев, в которых есть TODO.

О. Джонс
источник
Visual Studio начал делать комментарии // TODO: когда он впервые добавил генераторы кода для шаблонного материала MFC. Это была версия 2.0, iirc.
mjfgates
по крайней мере, для Visual studio этот поиск не чувствителен к регистру - он также перетянет // todo foo в список задач
jk.
4

Я просто выделяюсь и его легко поймать ... ничего сложного!

bunglestink
источник
1
это и его легко найти через grep или тому подобное
Захария К
@ZacharyK: Точно!
Динамичный
1

Обращает на себя внимание тот факт, что существует задача.

Важно, чтобы все время было очевидно, что кто-то должен вернуться к коду. Подробности должны быть известны только человеку, возвращающемуся для решения любой проблемы.

yfeldblum
источник
1

Если вы являетесь пользователем vi, используйте:

/ДЕЛАТЬ

Это доставит вас туда очень быстро.

ncmathsadist
источник
Другие редакторы имеют функции поиска, и вы можете также легко искать todo .
Карлсон
За исключением того, что «todo» может появляться в чем-то еще, например, в имени переменной или другом тексте комментария ...
sevenseacat
1
vi чувствителен к регистру. Поскольку заглавные буквы редко используются в большинстве современных языков (например, в именованных константах), поиск имеет высокую вероятность успеха.
ncmathsadist
1

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

Тим Абелл
источник
0

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

С точки зрения инструментов (IDE / Editor), поиск с учетом регистра будет иметь очень низкий процент ложных срабатываний во всех версиях заглавных букв. В некоторых стилях кодирования существует небольшой риск совпадения константы. Чувствительный к регистру поиск по всему слову делает ложные срабатывания еще менее вероятными.

Как только инструмент выводит его на экран, формат ясно говорит: смотрите ЗДЕСЬ. Как только вы сфокусируетесь на местоположении, читаемая часть будет связанным комментарием.

BillThor
источник