Co oznacza XXX w komentarzu? [Zamknięte]

Co ludzie zazwyczaj oznaczają, gdy widzisz XXXw komentarzu. Czasami zobaczę taki komentarz:

# XXX - This widget really should frobulate the whatsit

Oczywiście mogę powiedzieć, co oznacza komentarz, ale co ogólnie oznacza XXX? Czy to mówi „To jest hack”, a może „Może powinniśmy wrócić do tego później”? A może mówi coś zupełnie innego?

To XXX, co reprezentuje, zależy od autora kodu. Zasadniczo jest używany jako znacznik kodu, który wymaga uwagi.

Jednak ta strona internetowa przedstawia nieco inny tok myślenia:

XXX: używane do oznaczania czegoś, co jest fałszywe, ale działa

FIXME: służy do oznaczania czegoś fałszywego i zepsutego

Myślę, że to dalej pokazuje, że jego znaczenie nie jest dobrze zdefiniowane i jest używane inaczej.

To brudny kawałek kodu;)

Według Wikipedii : „XXX, aby ostrzec innych programistów przed problematycznym lub mylącym kodem”. - które można wyciągnąć z pojemników z trucizną, na których jest napisane „xxx”; super stara szkoła.

Jeśli jest to notatka do zrobienia, oto pokrewny post na blogu o nazwie TODO lub nie TODO , który obejmuje użycie GREP do sortowania komentarzy według daty, właściciela itp.

To nic nie znaczy. Jest to po prostu ciąg znaków, który jest wizualnie charakterystyczny (co ułatwia skanowanie pod kątem wizualnym) i raczej nie pojawia się ani w kodzie ani w komentarzach (co ułatwia wyszukiwanie programowe).

Jest więc używany jako znacznik do oznaczania komentarzy, które muszą być łatwe do przeszukiwania. Zazwyczaj oznacza fragment kodu, który należy ponownie odwiedzić.

IIRC to adnotacja, która poprzedza i ma podobne znaczenie do adnotacji TODO lub FIXME. Na przykład jest to dość powszechne w źródle vima.

Najprawdopodobniej jest to sekwencja znaków, która nie występuje w zwykłym kodzie, co oznacza, że ​​można ją łatwo przeszukiwać z poziomu wiersza poleceń:

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$ 

(przykład dotyczy Uniksa, uważam, że „findstr” robi to samo w systemie Microsoft Windows)

ale co ogólnie oznacza XXX? Czy to mówi „To jest hack”, a może „Może powinniśmy wrócić do tego później”? A może mówi coś zupełnie innego?

Dowolne z powyższych.

Wybór XXX kontra TODO, FIXME lub HACK lub coś innego nie podlega żadnym silnym regułom ani konwencjom. Zasadniczo oznacza to wszystko, co osoba, która go tam umieściła, miała na myśli. Może to być oczywiste ... lub może być całkowicie nieprzejrzyste.

AKTUALIZACJA Wikipedia obecnie (30.03.2016) mówi:

Takie tagi różnią się znacznie, ale mogą obejmować:

• ...
• XXX - ostrzegaj innych programistów o problematycznym lub mylącym kodzie

Zwróć uwagę na wyraźne zastrzeżenia w oryginalnym tekście. XXX można interpretować jako aluzję do „XXX”, który można zobaczyć na butelkach z trucizną i / lub bimbru w klasycznych komiksach, kreskówkach itp.

Najprawdopodobniej jest to marker, który można później znaleźć. W przeciwieństwie do TODO, FIXME lub podobnych, XXX jest bardzo rzadko spotykany w żadnym słowie lub konstrukcji, dlatego idealnie nadaje się do markera, który będzie samodzielny podczas przeszukiwania plików.

Tam, skąd pochodzę, używamy XXX (a następnie YYY, ZZZ) dla liczb, których jeszcze nie znamy, na przykład: dodaj XXX do YYY, aby znaleźć wynik, a następnie dodaj 10%.

Pochodzi z równań w szkole, gdzie „x” jest nieznaną zmienną.