it-swarm-eu.dev

Co znamená XXX v komentáři?

Co lidé obecně myslí, kdykoli uvidíte v komentáři XXX. Občas uvidím komentář jako je tento:

# XXX - This widget really should frobulate the whatsit

Samozřejmě můžu říct, co ten komentář znamená, ale co obecně znamená XXX? Říká to „Tohle je hack“ nebo možná „Možná bychom to měli později prohlédnout“? Nebo říká něco úplně jiného?

72
Jason Baker

Co XXX představuje, záleží na autorovi kódu. Obecně se používá jako značka pro kód, který vyžaduje pozornost.

Nicméně tato webová stránka uvádí poněkud odlišný směr myšlení:

XXX: používá se k označení něčeho falešného, ​​ale funguje

FIXME: používá se k označení něčeho falešného a zlomeného

Myslím, že to dále ukazuje, že jeho význam není dobře definován a používá se odlišně.

68
J.K.

Je to špinavý kus kódu;)

98
MattyD

Per Wikipedia : "XXX upozornit ostatní programátory na problematický nebo zavádějící kód." - které by mohly být vytaženy z jedovatých nádob, na nichž je uvedeno „xxx“; super stará škola.

Pokud se jedná o poznámku TODO, je zde související blogový příspěvek nazvaný TODO nebo ne TODO , který zahrnuje použití GREP k třídění komentářů podle data, vlastníka atd.

21
blunders

Nic to neznamená. Je to jen sekvence znaků, která je vizuálně rozlišovací (což usnadňuje vizuální vyhledávání) a je nepravděpodobné, že se objeví v kódu nebo poznámkách (což usnadňuje programové vyhledávání).

Používá se tedy jako značka k označení komentářů, které musí být snadno prohledatelné. Obvykle to označuje kus kódu, který je třeba revidovat.

13
Jörg W Mittag

IIRC je anotace, která předchází a má podobný význam jako anotace TODO nebo FIXME. Je to docela běžné například u vimova zdroje.

7
Rein Henrichs

Je to pravděpodobně znaková sekvence, která se nevyskytuje v běžném kódu, což znamená, že je snadno prohledávatelné z příkazového řádku:

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$ 

(Příklad je pro Unix, věřím, že "findstr" dělá totéž v Microsoft Windows)

6
user1249

co ale XXX obecně znamená? Říká to „Tohle je hack“ nebo možná „Možná bychom to měli později prohlédnout“? Nebo říká něco úplně jiného?

Něco z výše uvedeného.

Volba XXX versus TODO nebo FIXME nebo HACK nebo něco jiného se neřídí žádnými přísnými pravidly ani zvyklostmi. V podstatě to znamená cokoli, co to osoba, která ji tam uvedla, míní. Může to být zřejmé ... nebo pro vás může být naprosto neprůhledné.


[~ # ~] aktualizace [~ # ~] Wikipedia aktuálně (2016-03-30) říká:

Tyto značky se velmi liší, ale mohou zahrnovat:

  • ...
  • XXX - upozorněte ostatní programátory na problematický nebo zavádějící kód

Poznámka: jasné upozornění v původním textu. XXX by mohl být vytvořen jako narážka na „XXX“, které vidíte na lahvích s jedem a/nebo měsíčním svitem v klasických komiksech, karikaturách atd.

4
Stephen C

Je to pravděpodobně marker, který lze později najít. Na rozdíl od TODO nebo FIXME nebo podobně je XXX v jakémkoli slově nebo konstrukci velmi zřídka nalezen, takže je ideální pro značku, která bude při procházení souborů osamocena.

2
Rook

Tam, kde jsem původně, používáme XXX (a pak YYY, ZZZ) pro čísla, která ještě neznáme, například: přidejte XXX do YYY, abyste našli výsledek, pak přidejte 10%.

Pochází z rovnic ve škole, kde 'x' je neznámá proměnná.