代码样式;把javadoc放在注释之前还是之后？

coding-style java code-documentation annotations javadoc

2022-08-31 06:12:01

我知道这不是最重要的问题，但我刚刚意识到我可以把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;
}

答案 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) {
    ...
}

答案 2

我同意已经给出的答案。

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

因此，对我来说，将代码部分保持在一起是合理的。