Откуда появился префикс комментария XXX в Eclipse?

Я просто блуждал, почему префикс XXX?

Насколько я знаю, его использовали для заметок/напоминаний (или, по крайней мере, это то, для чего я его использую, и это то, что люди на большинстве ссылок, которые я использовал для поиска в Google).

Знает ли кто-нибудь, откуда берется префикс XXX?

Ответы

Ответ 1

Из слова Hacker Dictionary для "XXX" :

Маркер, в котором требуется внимание. Обычно используется в комментариях к программе указать области, которые были скопированы или должны быть. Некоторые хакеры сравнивают "XXX", к воображаемому тяжелому порнофильму рейтинг. Сравните FIXME.

Ответ 2

От Sun/Oracle Соглашения Java-кода, раздел 10.5.4:

Использовать XXX в комментарии, чтобы отметить что-то фиктивное, но работает. Используйте FIXME для обозначения того, что является фиктивным и сломанным.

Ответ 3

XXX, наряду с FIXME и TODO, известен в Eclipse как тег задачи и индексируется IDE, чтобы вы могли легко найти пятна, отмеченные этими тегами. Вы можете редактировать такие теги в настройках Eclipse Preferences → Java → Compiler → Task.

Что касается того, откуда он исходит: он, вероятно, появился из "тегов", которые программисты спонтанно писали в своем коде, чтобы быстро отметить данную строку. Хотя FIXME и TODO достаточно ясны, причиной использования XXX может быть сочетание этих причин:

  • Строка "XXX" обычно не встречается в обычном исходном коде и ее легко искать с помощью таких инструментов, как grep или простой текстовый поиск в редакторе;
  • Традиционно "Х обозначает место", которое требует внимания; три раза X, тем более,
  • Ключ X очень близок к клавишам Command/Alt/Windows и легко доступен, находясь в нижней строке клавиатуры.

Я ничего не могу придумать...

Ответ 4

Различные причины:

  • Легко искать.
  • Никакого столкновения, поскольку никакой здравомыслящий человек не использовал бы его как переменную.
  • Он может использоваться для обозначения кода, для которого требуется e * X * tra особое внимание, опасный код, который не может быть замечен в условиях недостаточной занятости и т.д.

Ответ 5

Я работал с командой, где XXX использовался для указания "ошибки или задачи, которые еще не были введены в Trac". После того, как он был введен в Trac, комментарий будет изменен на TODO с добавленным ID.

Чтобы затмить, это всего лишь маркер, как TODO и FIXME. Я предполагаю, что он изначально использовался как сильная форма TODO. Обычно вы видите такие комментарии:

// TODO: Need to optimize this once n becomes greater than 1000.

Но иногда у вас будет комментарий вроде:

// TODO: Fix SQL injection bug before production release!

К сожалению, быстрый grep не заставит эту ошибку SQL-инъекции выделяться среди 1000 других TODO s. Использование XXX здесь поможет отметить все, что должно быть сделано перед вехой/выпуском и т.д.

Ответ 6

Здесь также есть ссылка на Wikipedia:

XXX, чтобы предупредить других программистов о проблемном или ошибочном коде.

Ответ 7

Меня это тоже беспокоит, потому что XXX также можно использовать для маскировки ввода или форматирования чисел,

Таким образом, создается предупреждение о нескольких маркерах при описании формата суммы:

/**
 * @param amount (XXX or XXX.XX)
 */
public doSomething(String amount) {

Несколько маркеров на этой строке

-XXX или

-XXX.XX)

Как предложил @Jean-PhilippePellet, вы можете удалить его из

Настройки → Java → Компилятор → Теги задач