Question

我实际上可以在实际代码中看到Google Annotations Gallery的用途：

偶然发现以某种方式工作的代码超乎寻常的原因？生命是短暂的。标记它与@Magic一起继续前进：
@Magic
public static int negate(int n) {
  return new Byte((byte) 0xFF).hashCode()
      / (int) (short) '\uFFFF' * ~0
      * Character.digit ('0', 0) * n
      * (Integer.MAX_VALUE * 2 + 1)
      / (Byte.MIN_VALUE >> 7) * (~1 | 1);
}

这是一个严肃的问题。这可以用于实际的代码审查吗？

Answer 1

相当。好吧，不是所有的，但很多可以代替更长的评论。这适用于没有太多这些注释，但有些（如您的示例中）可能很方便。

可以说这些注释以较短且可能更易读的方式呈现最常见的注释。

您可以稍后处理它们，并添加例如@Magic注释数量的阈值。如果一个项目变得太“神奇”，就应该采取措施。

Answer 2

使用带有“MAGIC”等键的注释会更容易，然后使用这些注释。 Hudson和Eclipse以及其他工具可以对这些事件进行计数或标记。

Answer 3

我可以肯定地看到@CarbonFootprint如何适应多个客户的CSR政策，@WTF("comment")注释在您正在开展新项目时非常方便，您不确定是否实际上需要一段代码来解决一些疯狂的错误/角落条件，或者它是否只是随机的，留下的废话，当时没有人知道如何写得更好。

Answer 4

仅供参考，Sonar现在似乎包括better revision plugin。

无论如何，如果你不猜，我认为短项目的名称对于这个项目的意图已经足够清楚了：堵住他们在被释放时可以变成什么样的注释：等同于那么糟糕的XML地狱。< / p>

Answer 5

我猜有些人可能已经错过了4月1日谷歌注释图库（GAG）的首字母缩略词和日期......或者在某些国家，这可能不是开玩笑或噱头的国庆日......

Google Annotations Gallery在生产代码中有用吗？

5 个答案: