Qu'est-ce que XXX signifie dans un commentaire? [fermé]


72

Que veulent dire généralement les gens chaque fois que vous voyez XXXun commentaire? De temps en temps, je vais voir un commentaire comme celui-ci:

# XXX - This widget really should frobulate the whatsit

Bien sûr, je peux dire ce que le commentaire signifie, mais que signifie généralement le XXX? Est-il en train de dire "Ceci est un hack" ou peut-être "Peut-être devrions-nous revoir cela plus tard"? Ou dit-il autre chose entièrement?


3
Il existe de nombreuses références permettant de répondre à cette question: catb.org/jargon/html/X/XXX.html ; oracle.com/technetwork/java/javase/documentation/… ; c2.com/cgi/wiki?FixmeComment
pkh

Je l'utilise qazpersonnellement. Taper facilement et en 40 ans de codage, cela ne s'est jamais produit naturellement dans mon code, je peux donc le rechercher facilement. Plutôt que FixMe: ou ToDo: je l’utilise pour des piratages expérimentaux rapides que je peux facilement inverser s’ils ne fonctionnent pas. Mais mon neqaz serait jamais engagé dans le contrôle de code source, alors que FixMe: ou ToDo: ou XXX pourrait l'être.
Mawg

J'ai remarqué qu'il y a beaucoup de vieux commentaires XXX dans la base de code de Meteor ... une sorte de commentaire courant sur ses sales secrets. Et il semble qu'ils utilisent un outil pour les supprimer automatiquement du code qui est envoyé!
Andy

Réponses:


68

Ce qui XXXreprésente dépend de l'auteur du code. En général, il est utilisé comme marqueur pour le code qui nécessite une attention particulière.

Cependant, cette page Web énonce un courant de pensée quelque peu différent:

XXX: utilisé pour signaler quelque chose qui est faux mais qui fonctionne

FIXME: utilisé pour signaler quelque chose qui est faux et cassé

Je suppose que cela montre que sa signification n’est pas bien définie et qu’elle est utilisée différemment.


12
HACKserait une alternative à XXX.
Richard

1
Le lien est cassé :(
Jack

1
FIXME: link broken
Onewhaleid

1
HACK n'est pas une alternative à XXX. Le drapeau de commentaire XXX a une longue histoire et signifie essentiellement quelque chose qui fonctionne, mais qui nécessite une attention (fictive mais qui fonctionne).
Brill Pappin le

98

C'est un morceau de code sale ;)


20
Est-ce une réponse amusante ou une réponse amusante et correcte?
Koenmetsu

4
oh ces programmeurs coquins
aeracode

@koenmetsu drôle et précis. C'est faux , mais ça marche assez bien pour le moment, donc pas tout à fait faux. "Sale" est une description appropriée pour quelque chose qui fonctionne mais qui n'est pas tout à fait correct (c'est-à-dire propre).
Iiridayn

21

Par Wikipedia : "XXX pour avertir les autres programmeurs de code problématique ou erroné." - qui pourraient être retirés de contenants de poison portant l'inscription «xxx»; super vieille école.

S'il s'agit d'une note TODO, voici un article de blog associé, intitulé TODO ou non TODO , qui décrit l'utilisation de GREP pour trier les commentaires par date, propriétaire, etc.


13

Cela ne signifie rien. Il s'agit simplement d'une séquence de caractères distinctifs visuellement (ce qui facilite la recherche visuelle) et qui ont peu de chances d'apparaître dans le code ou les commentaires (ce qui facilite la recherche par programme).

Donc, il est utilisé comme marqueur pour marquer les commentaires qui doivent être facilement interrogeables. Habituellement, cela marque un morceau de code qui doit être revisité.


2
Aussi facile à trouver avec grep ou similaire
Zachary K

7

IIRC est une annotation qui précède et a une signification similaire à celle des annotations TODO ou FIXME. C'est assez courant dans la source de vim, par exemple.


6

Il s'agit très probablement d'une séquence de caractères qui ne figure pas dans le code normal, ce qui signifie qu'elle est facilement consultable à partir d'une ligne de commande:

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$ 

(l'exemple est pour Unix, je pense que "findstr" fait la même chose sous Microsoft Windows)


4

mais que signifie généralement XXX? Est-il en train de dire "Ceci est un hack" ou peut-être "Peut-être devrions-nous revoir cela plus tard"? Ou dit-il autre chose entièrement?

Tout ce qui précède.

Le choix entre XXX et TODO, FIXME ou HACK ou autre chose n'est régi par aucune règle ou convention stricte. Fondamentalement, cela signifie ce que la personne qui l'a mis là a voulu dire. Cela peut être évident ... ou il peut être totalement opaque pour vous.


MISE À JOUR Wikipedia actuellement (2016-03-30) dit:

Ces balises diffèrent largement, mais peuvent inclure:

  • ...
  • XXX - avertit les autres programmeurs du code problématique ou erroné

Notez les mises en garde claires dans le texte original. Le XXX peut être interprété comme une allusion au "XXX" que vous voyez sur des bouteilles de poison et / ou moonshine dans des bandes dessinées, des dessins animés, etc.


2

C'est très probablement un marqueur que l'on peut retrouver plus tard. Contrairement à TODO, FIXME ou autres, XXX est très rarement trouvé dans un mot ou une construction, ce qui le rend idéal pour un marqueur qui sera autonome lors de la recherche de fichiers.


0

D'où je viens, nous utilisons XXX (puis YYY, ZZZ) pour les nombres que nous ne connaissons pas encore, par exemple: ajoutez XXX à YYY pour trouver le résultat, puis ajoutez 10%.

Provient des équations à l'école où 'x' est la variable inconnue.

En utilisant notre site, vous reconnaissez avoir lu et compris notre politique liée aux cookies et notre politique de confidentialité.
Licensed under cc by-sa 3.0 with attribution required.