Java 注释的排序有什么约定吗？

Question

对于大量使用Java注解的项目，对于注解顺序有什么建议吗？从而统一团队内的代码风格。

Answer 1

我要说没有。我可能在这一点上被证明是错误的。

我的理由是，除了 Java 中的项目和 IDE 中的项目（特别是 Eclipse，但我确信其他项目也有它们）之外，还有数百个项目具有注释。

因此，所有这些库都具有潜在的竞争性对于“谁在上面”，我怀疑他们会同意一个标准。

我鼓励您的团队坐下来做出对你们最有利的决定。

我会考虑的因素：

1. 哪些注释最重要？他们应该接近顶部。
2. 哪些注释最有可能表明潜在的错误？他们应该接近顶部。
3. 类中的每个方法可能有哪些注释？它们应该接近底部。

Answer 2

如果你必须强加一个顺序，按字母顺序？

如果不了解您正在使用的注释，就很难提出合理的排序建议。也许更好的排序更适合您和您的团队；如果是这样，如果您记录了商定的顺序，那么剩下的唯一事情就是验证它是否遵循团队商定的顺序。

与您的整个团队交谈后，您可能会发现您根本不需要订购它们。

Answer 3

这不是一门精确的科学，但我尝试将注释从顶部的“宽范围”排列到底部的“窄范围”。这是一个例子：

@RadioDomain
@Entity
@Table(name = "receiver")
@ReceiverConstraintCheck
@SuppressWarnings("PMD.ShortVariable")
public class Receiver {
    // ...
}