Que signifie XXX dans un commentaire?
Que signifient généralement les utilisateurs chaque fois que vous voyez XXX dans un commentaire. Parfois, je vois un commentaire comme celui-ci:
# XXX - This widget really should frobulate the whatsit
Bien sûr, je peux dire ce que signifie le commentaire, mais que signifie généralement le XXX? Est-ce que ça dit "C'est un hack" ou peut-être "Peut-être qu'on devrait revoir ça plus tard"? Ou cela veut-il dire autre chose entièrement?
Ce que XXX représente, dépend de l'auteur du code. En général, il est utilisé comme un marqueur pour le code qui nécessite de l'attention.
Cependant, cette page Web indique une ligne de pensée quelque peu différente:
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 en outre que sa signification n'est pas bien définie et est utilisée différemment.
C'est un sale morceau de code;)
Per Wikipedia : "XXX pour avertir les autres programmeurs de code problématique ou erroné." - qui pourraient être retirés de conteneurs de poison portant la mention "xxx"; super vieille école.
S'il s'agit d'une note TODO, voici un article de blog connexe intitulé TODO ou non TODO , qui couvre l'utilisation de GREP pour trier les commentaires par date, propriétaire, etc.
Cela ne signifie rien. Il s'agit simplement d'une séquence de caractères visuellement distinctifs (ce qui facilite la recherche visuelle) et peu susceptibles d'apparaître dans le code ou les commentaires (ce qui facilite la recherche par programmation).
Ainsi, il est utilisé comme marqueur pour signaler les commentaires qui doivent être facilement consultables. Habituellement, il marque un morceau de code qui doit être revu.
IIRC c'est une annotation qui est antérieure et a une signification similaire aux annotations TODO ou FIXME. C'est assez courant dans la source de vim, par exemple.
Il s'agit très probablement d'une séquence de caractères qui ne se produit 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 crois que "findstr" fait la même chose sous Microsoft Windows)
mais que signifie généralement le XXX? Est-ce que ça dit "C'est un hack" ou peut-être "Peut-être qu'on devrait revoir ça plus tard"? Ou cela veut-il dire autre chose entièrement?
Tout ce qui précède.
Le choix de XXX par rapport à TODO ou FIXME ou HACK ou autre n'est pas régi par des règles ou des conventions strictes. Fondamentalement, cela signifie ce que la personne qui l'a mis là-bas voulait le dire. Cela peut être évident ... ou peut être totalement opaque pour vous.
[~ # ~] mise à jour [~ # ~] Wikipedia actuellement (2016-03-30) dit:
Ces balises diffèrent considérablement, mais peuvent inclure:
- ...
- XXX - avertir les autres programmeurs du code problématique ou erroné
Notez les mises en garde claires dans le texte original. Le XXX pourrait être interprété comme une allusion au "XXX" que vous voyez sur les bouteilles de poison et/ou de clair de lune dans les bandes dessinées classiques, les dessins animés, etc.
Il s'agit très probablement d'un marqueur que l'on pourra retrouver ultérieurement. Contrairement à TODO ou FIXME ou similaires, XXX est très rarement trouvé dans un mot ou une construction, ce qui le rend parfait pour un marqueur qui se tiendra seul lorsque les fichiers sont recherchés.
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 d'équations à l'école où "x" est la variable inconnue.