Eclipse中的XXX注释前缀来自哪里?

时间:2011-03-28 08:45:35

标签: java eclipse comments

我只是在徘徊为什么是前缀XXX

据我所知,它用于备注/提醒(或者至少这是我使用它的原因,这就是我用Google搜索的大多数链接上的人使用它)。

所以有人知道XXX前缀的来源吗?

7 个答案:

答案 0 :(得分:24)

来自Hacker's Dictionary entry for "XXX"

  

需要注意的标记。   常用于程序注释中   表示被淹没的区域或   需要。一些黑客比喻“XXX”   到了名义上的色情电影   评分。比较FIXME

答案 1 :(得分:23)

来自Sun / Oracle的Java code conventions, section 10.5.4:

  

在评论中使用XXX标记虚假但有效的内容。使用FIXME来标记虚假和破碎的东西。

答案 2 :(得分:9)

XXX以及FIXMETODO在Eclipse中称为任务标记,并由IDE编制索引,以便您轻松找到标记有这些标记的位置。您可以在Eclipse首选项中编辑此类标记 - > Java - >编译器 - >任务标签。

关于它来自何处:它可能出现在程序员自发地在代码中编写的“标签”中,以快速标记给定的行。虽然FIXME和TODO足够明确,但使用XXX的原因可能是这些原因的组合:

  • 字符串“XXX”通常不会出现在常规源代码中,并且很容易使用grep等工具或编辑器中的简单文本搜索来查找;
  • 传统上,“X标志着需要注意的地方”;三倍X更是如此;
  • X键非常靠近Command / Alt / Windows键,很容易触及,位于键盘的下排。

我想不出别的......

答案 3 :(得分:4)

各种原因:

  1. 搜索起来很容易。
  2. 没有碰撞,因为没有理智的人会将其用作变量。
  3. 它可用于标记需要e * X * tra特别注意的代码,危险代码,不被未成年人看见等。

答案 4 :(得分:3)

我曾与一个团队合作过,其中XXX被用来指出“尚未在Trac中输入的错误或任务”。在Trac中输入后,评论将更改为TODO并附加ID。

对Eclipse而言,它只是一个标记,如TODOFIXME。我想它最初用作TODO的强大形式。您通常会看到以下评论:

// TODO: Need to optimize this once n becomes greater than 1000.

但有时你会发表评论:

// TODO: Fix SQL injection bug before production release!

不幸的是,快速grep不会使SQL注入错误在其他TODO的1000个中脱颖而出。在这里使用XXX有助于标记在里程碑/发布等之前必须完成的事情。

答案 5 :(得分:2)

Wikipedia上还有对它的引用:

  

XXX警告其他程序员有问题或误导代码。

答案 6 :(得分:0)

这也让我很烦,因为 XXX 也可能用于掩盖输入或格式数字,

因此在描述金额格式时会创建多个标记警告:

/**
 * @param amount (XXX or XXX.XX)
 */
public doSomething(String amount) {
  

此行有多个标记

     

-XXX或

     

-XXX.XX)

按照@ Jean-PhilippePellet的建议,您可以将其从

中删除
  

首选项-> Java->编译器->任务标签