Was bedeutet XXX in einem Kommentar? [geschlossen]

72

Was bedeuten Menschen im Allgemeinen, wenn Sie XXXin einem Kommentar sehen. Gelegentlich sehe ich einen Kommentar wie diesen:

# XXX - This widget really should frobulate the whatsit

Natürlich kann ich sagen, was der Kommentar bedeutet, aber was bedeutet der XXX im Allgemeinen? Sagt es "Dies ist ein Hack" oder vielleicht "Vielleicht sollten wir das später noch einmal überprüfen"? Oder sagt es etwas ganz anderes?

Jason Baker
quelle
Ich qazpersönlich benutze . Einfach zu tippen und in 40 Jahren Codierung ist es in meinem Code noch nie vorgekommen, sodass ich leicht danach suchen kann. Anstelle von FixMe: oder ToDo: verwende ich es für schnelle experimentelle Hacks, die ich dann leicht rückgängig machen kann, wenn sie nicht funktionieren. Aber ich qazwürde mich niemals der Quellcodeverwaltung verschreiben, wohingegen FixMe: oder ToDo: oder XXX sein könnten.
Mawg
Mir ist aufgefallen, dass es in Meteors Codebasis viele alte XXX-Kommentare gibt ... sozusagen einen laufenden Kommentar zu seinen schmutzigen Geheimnissen. Und es sieht so aus, als würden sie mit einem Tool automatisch aus dem Code entfernt, der ausgeliefert wird!
Andy

Antworten:

68

Was XXXrepräsentiert, hängt vom Autor des Codes ab. Im Allgemeinen wird es als Markierung für Code verwendet, der Aufmerksamkeit erfordert.

Diese Webseite beschreibt jedoch einen etwas anderen Gedankengang:

XXX: Wird verwendet, um etwas zu kennzeichnen, das falsch ist, aber funktioniert

FIXME: Dient zum Kennzeichnen von gefälschten und beschädigten Objekten

Ich denke, dies zeigt weiter, dass seine Bedeutung nicht gut definiert ist und anders verwendet wird.

Jonathan Khoo
quelle
12
HACKwäre eine Alternative zu XXX.
Richard
1
Link ist kaputt :(
Jack
1
FIXME: link broken
onewhaleid
1
HACK ist keine Alternative zu XXX. Das XXX-Kommentar-Flag hat eine lange Geschichte und bedeutet im Wesentlichen, dass etwas funktioniert, aber Aufmerksamkeit benötigt (falsch, aber funktioniert).
Brill Pappin
98

Es ist ein schmutziges Stück Code;)

MattyD
quelle
20
Ist das eine lustige Antwort oder eine lustige und richtige Antwort?
Koenmetsu
4
oh diese frechen programmierer
aeracode
@ Koenmetsu lustig und genau. Es ist falsch , aber es funktioniert gut genug, also nicht ganz falsch. "Dirty" ist eine passende Beschreibung für etwas, das funktioniert, aber nicht ganz korrekt ist (dh sauber ist).
Freitag,
21

Per Wikipedia : "XXX, um andere Programmierer vor problematischem oder fehlgeleitetem Code zu warnen." - die aus Giftbehältern gezogen werden könnten, auf denen "xxx" steht; Super alte Schule.

Wenn es sich um eine TODO-Notiz handelt, finden Sie hier einen Blog-Beitrag mit dem Namen " TODO" oder "Nicht-TODO" , in dem die Verwendung von GREP zum Sortieren von Kommentaren nach Datum, Eigentümer usw. behandelt wird.

Fehler
quelle
13

Es bedeutet nichts. Es ist nur eine Folge von Zeichen, die sich optisch unterscheiden (was das Scannen nach visuellen Elementen erleichtert) und weder in Code noch in Kommentaren vorkommt (was das programmgesteuerte Suchen erleichtert).

Daher wird es als Markierung verwendet, um Kommentare zu kennzeichnen, die leicht durchsuchbar sein müssen. Normalerweise markiert es einen Code, der überarbeitet werden muss.

Jörg W. Mittag
quelle
2
Auch leicht mit grep oder ähnlichem zu finden
Zachary K
7

IIRC ist eine Annotation, die älter als TODO- oder FIXME-Annotationen ist und eine ähnliche Bedeutung hat. Das ist zum Beispiel in Vims Quellen ziemlich verbreitet.

Rein Henrichs
quelle
6

Es handelt sich höchstwahrscheinlich um eine Zeichenfolge, die im regulären Code nicht vorkommt, was bedeutet, dass sie leicht über eine Befehlszeile durchsucht werden kann:

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$ 

(Beispiel ist für Unix, ich glaube "findstr" macht dasselbe unter Microsoft Windows)


quelle
4

aber was bedeutet der XXX generell? Sagt es "Dies ist ein Hack" oder vielleicht "Vielleicht sollten wir das später noch einmal überprüfen"? Oder sagt es etwas ganz anderes?

Beliebige der oben genannten.

Die Wahl von XXX gegenüber TODO oder FIXME oder HACK oder etwas anderem unterliegt keinen strengen Regeln oder Konventionen. Grundsätzlich bedeutet es, was auch immer die Person, die es dort abgelegt hat, damit gemeint hat. Es kann offensichtlich sein ... oder es kann für Sie völlig undurchsichtig sein.


UPDATE Wikipedia aktuell (30.03.2016) sagt:

Solche Tags unterscheiden sich stark voneinander, können jedoch Folgendes umfassen:

  • ...
  • XXX - warnen Sie andere Programmierer vor problematischem oder fehlgeleitetem Code

Beachten Sie die klaren Vorbehalte im Originaltext. Das XXX könnte als Anspielung auf das "XXX" ausgelegt werden, das Sie auf Gift- und / oder Mondscheinflaschen in klassischen Comics, Cartoons usw. sehen.

Stephen C
quelle
2

Es ist höchstwahrscheinlich ein Marker, der später gefunden werden kann. Im Gegensatz zu TODO, FIXME oder ähnlichem kommt XXX in keinem Wort oder Konstrukt vor und eignet sich daher perfekt für einen Marker, der beim Durchsuchen von Dateien eigenständig ist.

Turm
quelle
0

Woher ich ursprünglich komme, verwenden wir XXX (und dann YYY, ZZZ) für Zahlen, die wir noch nicht kennen. Zum Beispiel: Addiere XXX zu YYY, um das Ergebnis zu finden, und addiere dann 10%.

Entsteht aus Gleichungen in der Schule, in denen 'x' die unbekannte Variable ist.

Dimitrios Mistriotis
quelle