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

Question

我知道这不是最重要的问题,但我只是意识到我可以在注释之前或之后放置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页面中找到的随机示例:

/**
 * 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 doc注释.否则工作正常.