Que veulent dire généralement les gens chaque fois que vous voyez XXX
un 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?
comments
coding-standards
Jason Baker
la source
la source
qaz
personnellement. 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.Réponses:
Ce qui
XXX
repré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:
Je suppose que cela montre que sa signification n’est pas bien définie et qu’elle est utilisée différemment.
la source
HACK
serait une alternative àXXX
.FIXME: link broken
C'est un morceau de code sale ;)
la source
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.
la source
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é.
la source
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.
la source
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:
(l'exemple est pour Unix, je pense que "findstr" fait la même chose sous Microsoft Windows)
la source
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:
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.
la source
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.
la source
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.
la source