Quel est le sens de l' #XXX?

Question

J'ai vu beaucoup de fois dans le code, même vim marque comme un cas spécial. #TODO et #FIXME sont deux autres fix marqueurs vim points forts, mais qu'est - #XXX moyenne?

Answer 1

XXX dans un commentaire est généralement un heads-up. Il pourrait être:

• Quelque chose qui n'est pas complètement mis en œuvre correctement.
• Quelque chose qui devrait être fixé plus tard.
• Mettant en évidence un possible problème de place.
• Quelque chose que vous n'êtes pas sûr à ce sujet, une question.

J'ai souvent préféré un plus descriptif tag FIXME ou TODO ou HACK. XXX est souvent utilisé comme un fourre-tout pour les ci-dessus.

La recherche de 'XXX' sur le code de FreeBSD renvoi en est un bon exemple de nombreuses utilisations. Il y a des milliers...

Answer 2

• NOTE: Description de la façon dont le code fonctionne (quand elle n'est pas évident).
• XXX: Avertissement à propos des pièges possibles, peut être utilisé comme NOTE:XXX:.
• HACK: Pas très bien écrit ou mal, code de contourner un problème/bug. Doit être utilisé en tant que HACK:FIXME:.
• FIXME: Cela fonctionne, en quelque sorte, mais il pourrait faire mieux. (généralement le code écrit dans la hâte que les besoins de réécriture).
• BUG: Il y a un problème ici.
• TODO: Pas de problème, mais en plus, le code doit être écrit, généralement lorsque vous êtes à sauter quelque chose.

Au moins ce est ce que j'ai appris au sujet de ces balises. Fondamentalement, les deux premiers (NOTE et XXX) sont utilisés pour de l'information et aucune action n'est requise. Tandis que les trois derniers (FIXME, BUG et TODO) ne requièrent une action. HACK est quelque part entre les deux (et presque jamais utilisé, je pense?).

Answer 3

Quelques notes de un juin 2005 Python Amélioration de la Proposition qui a été rejetée.

Le choix entre FIXME et XXX est difficile.
XXX semble être la plus commune, mais beaucoup moins descriptive.
En outre, XXX est utile de l'espace réservé dans un morceau de code
ayant une valeur qui est inconnu.

Ainsi, FIXME est le préféré de l'orthographe.
Sun a dit qu' XXX et FIXME sont légèrement différents, donnant XXX plus élevés de la gravité.
Cependant, avec des décennies de chaos sur ce sujet, et trop nombreux, des millions de
les développeurs qui ne sera pas influencée par le Soleil, il est facile à juste titre appeler des synonymes.

---

Le PEP Commence avec,

Ce PEP a été rejetée. Alors que la communauté peut être intéressé,
il n'y a pas de volonté de faire de la bibliothèque standard sont conformes à ce standard.

...

Quelles Sont Codetags?

Les programmeurs utilisent largement ad-hoc commentaire de code de balisage conventions de servir à titre de rappels de sections de code qui doivent rapprocher de l'inspection ou de l'examen. Exemples de balisage comprennent FIXME, TODO, XXX, BUG, mais il y a beaucoup plus dans une large utilisation dans les logiciels existants. Ces le balisage sera désormais dénommé codetags. Ces codetags peut s'afficher dans le code de l'application, les tests unitaires, les scripts, le général de la documentation, ou tout autre endroit approprié.

---

Le PEP est une lecture intéressante.

Answer 4

J'utilise XXX parce que c'est plus facile à taper que TODO.

XXX est pour quand vous êtes pressé et reviendrons vers vous-même.

TODO est pour quand vous avez à portée de main à quelqu'un d'autre.

Answer 5

Probablement que c'est pour les cas que vous ne savez pas comment gérer.
Découvrez ce: affichage de la Liste de TODO/FIXME/XXX/HACK états