我知道这不是最重要的问题，但我刚刚意识到可以将javadoc注释块放在注释之前或之后。我们希望采用什么作为编码标准?
/**
* This is a javadoc comment before the annotation
*/
@Component
public class MyClass {
@Autowired
/**
* This is a javadoc comment after the annotation
*/
private MyOtherClass other;
}
当前回答
我同意已经给出的答案。
注释是代码的一部分，而javadoc是文档的一部分(因此得名)。
所以对我来说，将代码部分放在一起是合理的。
其他回答
除了编码标准之外，如果javadoc注释放在注释之后，javadoc工具似乎不会处理它们。其他工作都很好。
这一切都归结于可读性。在我看来，直接在方法/字段上方标注代码更具可读性。
以上我都同意。IntelliJ (Idea)的代码风格模板在使用RestEasy风格注释时，既会错误地为正(当@throws被正确指定时，它会发出警告)，也会错误地为负(当@throws未被指定时，但应该指定)，这可能会对其他人有所帮助。我把javadocs放在其他所有东西之上，然后是注释，然后是代码。
在这里查看错误报告: https://youtrack.jetbrains.com/issue/IDEA-220520
在注释之前，因为注释是“属于”类的代码。 请参阅官方文档中的javadoc示例。
下面是我在另一个官方Java页面上找到的一个随机示例:
/**
* Delete multiple items from the list.
*
* @deprecated Not for public use.
* This method is expected to be retained only as a package
* private method. Replaced by
* {@link #remove(int)} and {@link #removeAll()}
*/
@Deprecated public synchronized void delItems(int start, int end) {
...
}
我同意已经给出的答案。
注释是代码的一部分，而javadoc是文档的一部分(因此得名)。
所以对我来说，将代码部分放在一起是合理的。
