it-swarm.dev

Was bedeutet XXX in einem Kommentar?

Was bedeuten Menschen im Allgemeinen, wenn Sie XXX in 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 wiederholen"? Oder sagt es etwas ganz anderes?

72
Jason Baker

Was XXX darstellt, hängt vom Autor des Codes ab. Im Allgemeinen wird als Marker für Code verwendet, der Aufmerksamkeit erfordert.

diese Webseite gibt jedoch einen etwas anderen Gedankengang an:

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

FIXME: Wird verwendet, um etwas zu markieren, das gefälscht und kaputt ist

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

68
J.K.

Es ist ein schmutzig Stück Code;)

98
MattyD

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 verwandten 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.

21
blunders

Es bedeutet nichts. Es ist nur eine Folge von Zeichen, die visuell unterscheidbar ist (was das visuelle Suchen erleichtert) und wahrscheinlich weder in Code noch in Kommentaren erscheint (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.

13
Jörg W Mittag

IIRC ist eine Annotation, die älter ist als TODO- oder FIXME-Annotationen und eine ähnliche Bedeutung hat. Dies ist beispielsweise in der Quelle von vim durchaus üblich.

7
Rein Henrichs

Es ist höchstwahrscheinlich eine Zeichenfolge, die im regulären Code nicht vorkommt, was bedeutet, dass sie leicht durchsuchbar über eine Befehlszeile ist:

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 das gleiche unter Microsoft Windows)

6
user1249

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

Eine der oben genannten.

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


[~ # ~] update [~ # ~] Wikipedia aktuell (2016-03-30) sagt:

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

  • ...
  • XXX - warnt andere Programmierer vor problematischem oder fehlgeleitetem Code

Beachten Sie die deutlichen Einschränkungen im Originaltext. Der XXX könnte als Anspielung auf den "XXX" ausgelegt werden, den Sie auf Gift- und/oder Mondscheinflaschen in klassischen Comics, Cartoons usw. sehen.

4
Stephen C

Es ist höchstwahrscheinlich ein Marker, der später gefunden werden kann. Im Gegensatz zu TODO, FIXME oder Ähnlichem wird XXX in keinem Word oder Konstrukt sehr selten gefunden, sodass es sich perfekt für einen Marker eignet, der beim Durchsuchen von Dateien eigenständig ist.

2
Rook

Wo ich ursprünglich herkomme, verwenden wir XXX (und dann JJJ, ZZZ) für Zahlen, die wir noch nicht kennen. Beispiel: Fügen Sie XXX zu JJJ hinzu, um das Ergebnis zu finden, und fügen Sie dann 10% hinzu.

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