我浏览了这个论坛,并用谷歌搜索了这个论坛,但我不确定处理 Javadoc 和同一类中一起出现的注释的最佳方法是什么。
从我从 Sun/Oracle 的文档中可以看出,他们似乎建议(尽管我真的找不到明确的声明)Javadoc 应该列在注释之上。
请参阅他们的示例How and When Deprecate API's。
这对于像@Deprecated 或@Override 这样简单的东西非常有用。但是如果你使用 JPA 和/或 Hibernate 呢?您的类和方法肯定会被大量注释(有时每个类或方法有两个或更多注释)。
我猜 Javadoc 仍然在注释之上?
另外我想知道如何最好地使用注释?我已经看到了一些示例,其中注释“堆叠”在类、成员、方法之上。我见过其他人在同一行列出注释(通常是这里的方法)。
哪个最好?哪个更具可读性?
您是否“记录”了您在 Javadoc 中注释某些内容的事实?
我正在寻找关于这方面的一套好的文档和/或您自己关于什么是最易读/可维护的经验。