Що означає XXX у коментарі? [зачинено]


71

Що зазвичай означають люди, коли ви бачите XXXв коментарі. Інколи я побачу такий коментар:

# XXX - This widget really should frobulate the whatsit

Звичайно, я можу сказати, що означає коментар, але що взагалі означає XXX? Це приказка "Це злом" чи, можливо, "Ми повинні переглянути це пізніше"? Або це говорить щось інше цілком?


3
Існує безліч посилань, за допомогою яких можна відповісти на це питання: catb.org/jargon/html/X/XXX.html ; oracle.com/technetwork/java/javase/documentation/… ; c2.com/cgi/wiki?FixmeComment
pkh

Я використовую qazособисто. Легко набрати, і за 40 років кодування воно ніколи не траплялося природним чином у моєму коді, тому я легко можу шукати його. Замість того, щоб FixMe: або ToDo: я використовую його для швидких експериментальних хакерів, які потім я можу легко змінити, якщо вони не виходять. Але мій qazніколи б і НЕ бути віддані джерело управління, в той час як FIXME: або ToDo: або XXX може бути.
Mawg

Я помітив, що в кодовій базі Метеора є багато старих коментарів XXX ... якийсь ходовий коментар щодо його брудних секретів. Здається, вони використовують якийсь інструмент, щоб автоматично викреслити їх з коду, який постачається!
Енді

Відповіді:


68

Що XXXпредставляє, залежить від автора коду. Взагалі він використовується як маркер для коду, який вимагає уваги.

Однак на цій веб-сторінці зазначено дещо інший порядок мислення:

XXX: використовується для позначення того, що є хибним, але працює

FIXME: використовується для позначення фальшивого і зламаного

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


12
HACKбуло б альтернативою XXX.
Річард

1
посилання розірвано :(
Джек

1
FIXME: link broken
Один вілейлеїд

1
HACK не є альтернативою XXX. Прапор коментаря XXX має довгу історію і по суті означає щось, що працює, але потребує уваги (хибно, але працює).
Брілл Паппін

98

Це брудний фрагмент коду;)


20
Це смішна відповідь чи смішна і правильна відповідь?
koenmetsu

4
о, ці неслухняні програмісти
аерокод

@koenmetsu веселий і акуратний. Це неправильно , але зараз працює досить добре, тому не зовсім неправильно. "Брудне" - це влучний опис того, що працює, але не зовсім коректно (тобто чисто).
Іїрідайн

21

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

Якщо це примітка TODO, ось пов’язана публікація блогу під назвою TODO чи ні TODO , яка охоплює використання GREP для сортування коментарів за датою, власником тощо.


13

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

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


2
Також легко знайти з грепом або подібним
Zachary K

7

IIRC - це анотація, яка передує і має подібне значення до анотацій TODO або FIXME. Наприклад, це досить поширене джерело vim.


6

Це, швидше за все, послідовність символів, яка не зустрічається у звичайному коді, а це означає, що її легко знайти з командного рядка:

ravn:tmp ravn$ echo XXXX This is very bad > processor.c
ravn:tmp ravn$ echo XXXX Verify defaults before going in production > main.c
ravn:tmp ravn$ grep -R XXXX .
./main.c:XXXX Verify defaults before going in production
./processor.c:XXXX This is very bad
ravn:tmp ravn$ 

(наприклад, для Unix, я вважаю, що "findstr" робить те ж саме в Microsoft Windows)


4

але що взагалі означає XXX? Це приказка "Це злом" чи, можливо, "Ми повинні переглянути це пізніше"? Або це говорить щось інше цілком?

Будь-яке з перерахованого вище.

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


ОНОВЛЕННЯ Вікіпедії на даний момент (2016-03-30) говорить:

Такі теги широко відрізняються, але можуть включати:

  • ...
  • XXX - попередити інших програмістів про проблемний чи помилковий код

Зверніть увагу на чіткі застереження в оригінальному тексті. XXX може трактуватися як алюзія на "XXX", яку ви бачите на отрутах та / або самогонних пляшках у класичних коміксах, мультфільмах тощо.


2

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


0

Звідки я родом, ми використовуємо XXX (а потім YYY, ZZZ) для номерів, про які ми їх ще не знаємо, наприклад: додайте XXX до YYY, щоб знайти результат, а потім додайте 10%.

Походить з рівнянь у школі, де 'x' - невідома змінна.

Використовуючи наш веб-сайт, ви визнаєте, що прочитали та зрозуміли наші Політику щодо файлів cookie та Політику конфіденційності.
Licensed under cc by-sa 3.0 with attribution required.