对于大量使用Java注释的项目,是否对注释顺序有任何建议?从而统一团队中的代码风格。
对于大量使用Java注释的项目,是否对注释顺序有任何建议?从而统一团队中的代码风格。
我要说没有。我可以证明这是错误的。
我的理由是有数百个带注释的项目,除了Java中的注释,以及我们的IDE(特别是Eclipse,但我确信其他人也有它们)。
因此,所有这些图书馆都有可能与“谁在最高层”竞争,我怀疑他们是否同意一个标准。
我鼓励你的团队坐下来决定什么对你们最好。
我会考虑的因素:
如果你必须按顺序强制执行命令?
如果没有关于您正在使用的注释的某种知识,很难建议合理的排序。也许更好的订购会更适合您和您的团队;如果是这样,如果您记录了约定的订单,那么唯一剩下的就是按照团队同意的顺序进行验证。
在与整个团队交谈之后,您可能会发现您根本不需要订购它们。
好问题。这不是一门精确的科学,但我个人试着将注释从顶部的“宽范围”安排到底部的“窄范围”。这是一个例子:
@RadioDomain
@Entity
@Table(name = "receiver")
@ReceiverConstraintCheck
@SuppressWarnings("PMD.ShortVariable")
public class Receiver {
// ...
}