对于如何对 Java 注释进行排序,是否有任何约定?

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


答案 1

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

我的理由是,除了那些被Java烘焙的项目,以及那些被烘焙到我们的IDE中的项目(特别是Eclipse,但我相信其他人也有注释之外,还有数百个项目有注释。

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

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

我会考虑的因素:

  1. 哪种安诺塔提奥森最重要?它们应该靠近顶部。
  2. 哪些注释最有可能引发潜在的错误?它们应该靠近顶部。
  3. 类中每个方法上都可能有哪些注释?它们应该靠近底部。

答案 2

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

如果不对你正在使用的注释有某种了解,就很难建议一个合理的排序。也许更好的排序更适合您和您的团队;如果是这样,如果您记录了商定的订单,剩下的唯一事情就是验证它是否遵循团队商定的订单。

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