建议的Java注释顺序？

Question

对于大量使用Java注释的项目，是否对注释顺序有任何建议？以便统一团队中的代码风格。

Answer 1

我要说没有。我在这方面可能被证明是错误的。

我的理由是有数百个带注释的项目，除了Java中的注释，以及我们的IDE中的那些项目（特别是Eclipse，但我相信其他人也有。）

所以，由于所有这些图书馆都有可能与“谁在最高层”竞争，我怀疑他们会同意一个标准。

我鼓励你的团队坐下来决定什么对你们最好。

我会考虑的因素：

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

Answer 2

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

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

Answer 3

如果您必须按字母顺序排序？

如果没有关于您正在使用的注释的某些知识，很难建议合理的排序。也许更好的订购会更适合您和您的团队;如果是这样，如果您记录了约定的订单，那么唯一剩下的就是按照团队同意的顺序进行验证。

在与整个团队交谈之后，您可能会发现毕竟不需要订购它们。