java - 是否有任何关于如何订购 Java 注释的约定？

Question

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

Answer 1

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

我的理由是，除了嵌入到 Java 中的项目和嵌入到我们的 IDE 中的项目(特别是 Eclipse，但我相信其他人也有)之外，还有数百个项目具有注释。

因此，鉴于所有这些库都可能争夺“谁在上面”，我怀疑他们是否会就标准达成一致。

我会鼓励您的团队坐下来决定什么对你们最有利。

我会考虑的因素:

1. 哪些注释最重要？它们应该靠近顶部。
2. 哪些注释最有可能指示潜在的错误？它们应该靠近顶部。
3. 哪些注释可能出现在类中的每个方法上？它们应该靠近底部。