codestyle; 在注释之前或之后放置javadoc？

我知道这不是最重要的问题，但我只是意识到，我可以在注释之前或之后放置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; } 

Answer 1

在注解之前，由于注释是“属于”类的代码。 在官方文档中查看javadoc的示例 。

这是我在另一个官方Java页面中find的随机例子：

 /** * 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) { ... } 

Answer 2

我同意已经给出的答案。

注释是代码的一部分，而javadoc是文档的一部分（因此名称）。

所以对我来说合理的代码部分保持一致。

Answer 3

这一切归结为可读性。 在我看来，代码更直观的方法/领域直接上面的注释。

Answer 4

除了编码标准，似乎javadoc工具不处理java文档评论，如果他们被放置在注释之后。 否则工作正常。