Чому всі пишуть зауваження великими літерами? [зачинено]

9

Наразі це запитання не підходить для нашого формату запитань. Ми очікуємо, що відповіді будуть підкріплені фактами, посиланнями або експертними знаннями, але це питання, ймовірно, вимагатиме дискусій, аргументів, опитувань чи розширеної дискусії. Якщо ви вважаєте, що це питання можна вдосконалити та, можливо, знову відкрити, відвідайте довідковий центр для ознайомлення .

Закрито 7 років тому .

Я роблю те саме. Коли в моєму коді є щось "обов'язкове", я пишу //TODO .... Але мені цікаво дізнатись, коли це почалося, і чи є причина писати «до-дос» усіма великими літерами?

comments

— Мохсен
джерело

20

Тому що ми дійсно МОЄМО це (ми просто ніколи насправді не обходимо його)

— Ентоні Пеграм

3

тому редактори можуть помітити їх і дозволяють здійснювати пошук через них (список завдань в Eclipse, наприклад)

— храповим урод

6

Оскільки ви насправді не могли зробити текст жирним кольором всередині коду, вам потрібен був спосіб виділити важливі речі. Звідси ...

— Карлсон

4

Чому це важливо?

— Грак

3

Пишу//todo:...

— BЈович

23

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

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

— Буттер Буткус
джерело

4

Це також дозволяє редакторам виділити це. Наприклад, gedit робить це лише для всіх верхніх регістрів TODO. Якою б не була причина, для мене достатньо стимулів писати це у великому регістрі.

4

@delnan: Це тавтологія. Це було зроблено, щоб стирчати, тому люди використовували його, тому хтось додав виділення синтаксису in vim, щоб виділитися більше, тому люди використовують його, щоб виділитися. Люди не використовують його, тому що редактор виділяє його, вони використовують його, тому що це звичайно, і таким чином редактор робить його виділенням. Ви можете зробити що-небудь виділення у vim, просто змінити підсвічування синтаксису належним чином - це так само просто todoвиділити, але мало сенсу в цьому, як умовою є використання TODO.

— Мартін Йорк

1

@LokiAstari: Як я вже сказав, я за один раз написав це у великих літерах, оскільки більше редакторів підкреслює це за замовчуванням. Але, мабуть, я виняток: зовсім молодий (тому я не міг би цього зробити, доки редактори його не підтримали) і (на жаль) занадто багато хнукання та ледачого бамжа, щоб налаштувати підкреслення синтаксису вручну.

Також приємно для бідного хлопця, який потребує прибирання за вами, і для всіх, кому потрібно переглянути ваш код, перш ніж він буде заповнений. Вони можуть з першого погляду побачити, що ще не зроблено через цю конвенцію.

— sq33G

2

Я зіткнувся зі змішаним регістром TODO в межах назви змінної на зразок filesToDownload. Звичайно, пошук "лише цілих слів" вирішує цю проблему.

— dan04

8

Мені цікаво дізнатись, коли це почалося, і чи є причина писати в -дос весь капітал?

Ідея з коментарями на кшталт TODO та FIXME полягає в тому, щоб змусити їх висуватися. Як правило, ви не хочете надсилати код, який містить такі маркери в коді - вони позначають речі, які потрібно виконати до того, як проект можна буде вважати завершеним. Використання ВСІХ КАПС полегшує їх виявлення, якщо ви також не використовуєте ВСІ КАПСИ для багатьох інших речей у своєму коді.

— Калеб
джерело

5

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

— О. Джонс
джерело

Visual Studio почав робити // TODO: коментарі, коли вперше додав генератори коду для котла MFC. Це була версія 2.0, iirc.

— mjfgates

принаймні для Visual studio цей пошук не відрізняється від регістру - він також втягне // todo foo в список завдань

— jk.

4

Я просто виділяється і легко ловити ... нічого складного!

— bunglestink
джерело

1

це і його легко знайти через grep або подібне

— Захарій K

@ZacharyK: Саме так!

— Динамічний

1

Він звертає увагу на те, що існує тодо.

Важливо, щоб весь час було очевидно, що комусь потрібно повернутися до коду. Інформація повинна знати лише особа, яка повертається, щоб вирішити будь-яке питання.

— yfeldblum
джерело

1

Якщо ви користувач vi, використовуйте:

/ЗРОБИТИ

Він потрапить до вас дуже швидко.

— ncmathsadist
джерело

Інші редактори мають функції пошуку, і ви можете так само легко шукати todo .

— Карлсон

За винятком того, що 'todo' може з’явитися в чомусь іншому, як назва змінної чи інший текст коментаря ...

— sevenseacat

1

vi залежить від регістру. Оскільки шапки використовуються в більшості сучасних мов (наприклад, названі константи), пошук має високу ймовірність успіху.

— ncmathsadist

1

Деякі редактори виділяють лише великі елементи TODO, тому безпечніше завжди використовувати великі регістри.

— Тім Ебелл
джерело

0

Візуально ВСІ КАПИ виділяються, але не дуже розбірливі. Під час читання коду вони сканують як блок певного розміру. Це насправді не має значення, які букви. Вони просто виділяються і їх можна побачити дуже швидко. Після того як ви деякий час працюєте з тегами, ваш мозок розпізнає слово за формою.

З точки зору інструментів (IDE / Editor), у випадку, коли реєструються великі регістри, пошук у всіх версіях великих літер має дуже низький показник помилок. У деяких стилях кодування є невеликий ризик відповідності константи. Шукати цілим словом, що враховує великі регістри, робить помилкові позитиви ще менш імовірними.

Як тільки інструмент виведе його на екран, формат чітко говорить, дивіться ТУТ. Після того, як ви зосередитесь на місці розташування, розбірливою частиною буде відповідна коментар.

— BillThor
джерело