有用的Java注释

我为其他用户分发了一堆赞成票，但只是为了给我两美分，我在开发中使用的任何规律性的唯一三个注释是编译器直接使用的主要注释：

@Override - 非常适合在重写其他方法时在代码中显式显示它。此外，如果您没有以您认为的方式覆盖方法，则还会被标记为编译错误的额外好处（请参阅此其他SO文章）。此标志通知编译器您打算重写某些内容，因此，如果您不这样做（例如，您忘记了方法签名中的参数），编译器将捕获它。

@Deprecated - 指出您标记为从现在开始不应使用的任何内容。编译器将生成警告，以使用已标记为已弃用的任何代码元素。一般来说，弃用说“这在过去是在这里，但它可能会在将来的版本中消失。确保你也使用相关的“@deprecated”Javadoc标志来告诉人们他们应该使用什么。

@SuppressWarnings - 告诉编译器禁止显示否则将生成的特定警告。这对于某些情况非常有用，例如，当您有意使用已弃用的方法时，可以阻止弃用警告。我倾向于经常使用它来阻止每个人最喜欢的“序列化UID”警告（你是否应该这样做是另一个时间的争论）。对于那些知道你正在做的事情正在产生警告，但你100%确定这是你想要的正确行为的情况，这很方便。

查看 Sun 注释指南，并查看“编译器使用的注释”部分。这三者进行了相当长时间的讨论。

Java 并发实践注释

对于准确描述您的代码如何是线程安全或不线程安全的非常有用...