Откуда взялся префикс комментариев XXX в Eclipse? - PullRequest
18 голосов
/ 28 марта 2011

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

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

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

Ответы [ 7 ]

24 голосов
/ 25 октября 2011

Из соглашений Sun / Oracle Java code, раздел 10.5.4:

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

24 голосов
/ 28 марта 2011

Из словарного словаря хакера для "XXX" :

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

9 голосов
/ 28 марта 2011

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

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

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

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

4 голосов
/ 28 марта 2011

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

  1. Легко искать.
  2. Нет столкновений, поскольку ни один здравомыслящий человек не будет использовать его в качестве переменной.
  3. Может использоватьсяпометить код, который требует e * X * для особого внимания, опасный код, невидимый для несовершеннолетних и т. д.
3 голосов
/ 28 марта 2011

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

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

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

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

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

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

2 голосов
/ 25 сентября 2012

Есть также ссылка на него в Wikipedia :

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

0 голосов
/ 14 мая 2019

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

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

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

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

-XXX или

-XXX.XX)

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

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

Добро пожаловать на сайт PullRequest, где вы можете задавать вопросы и получать ответы от других членов сообщества.
...