Eclipse中的XXX注释前缀来自哪里?
我只是在徘徊为什么前缀是XXX
?
据我所知,它用于笔记/提醒(或者至少这是我使用它,这就是我用Google搜索的大多数链接上的人使用它)。
那么有谁知道XXX
前缀来自哪里?
来自Hacker’s Dictionary的“XXX”条目 :
需要注意的标记。 常用于程序注释,以指示被克服或需要的区域。 一些黑客将“XXX”比作名义上的重色情电影评级。 比较FIXME 。
从Sun / Oracle的Java代码约定,第10.5.4节:
在评论中使用XXX来标记虚假但有效的内容。 使用FIXME标记虚假和破坏的东西。
XXX
与FIXME
和TODO
一起在Eclipse中称为任务标记,并由IDE编制索引,以便您轻松找到标记有这些标记的点。 您可以在Eclipse首选项 – > Java – >编译器 – >任务标签中编辑此类标签。
至于它来自何处:它可能是程序员在代码中自发编写的“标签”,以快速标记给定的行。 虽然FIXME和TODO足够明确,但使用XXX的原因可能是以下原因的组合:
- 字符串“XXX”通常不会出现在常规源代码中,并且很容易使用grep等工具或编辑器中的简单文本搜索来查找;
- 传统上,“X标志着需要注意的地方”; 三倍X更是如此;
- X键非常靠近Command / Alt / Windows键,很容易到达,位于键盘的下排。
我什么都想不到……
我曾与一个团队合作过,其中XXX
曾被用来指出“尚未在Trac中输入的错误或任务”。 在Trac中输入后,评论将更改为TODO
并附加ID。
但是对于Eclipse来说,它只是像TODO
和FIXME
这样的标记。 我想它最初用作TODO
的强大forms。 您通常会看到以下评论:
// TODO: Need to optimize this once n becomes greater than 1000.
但有时候你会发表评论:
// TODO: Fix SQL injection bug before production release!
不幸的是,快速的grep
不会使这个SQL注入bug在其他TODO
的1000个中脱颖而出。 在这里使用XXX将有助于标记在里程碑/发布等之前必须完成的事情。
很多原因:
- 它很容易搜索。
- 没有碰撞,因为没有理智的人会将它用作变量。
- 它可用于标记需要e * X * tra特别注意的代码,危险代码,不被未成年人看见等。
维基百科上也有对它的引用:
XXX警告其他程序员有问题或误导代码。