在注释之前还是之后放置javadoc?

在注释之前,因为注释是“属于”类的代码。 见 examples with javadoc 在官方文件中。

以下是我在 another official Java page :

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

我同意已经给出的答案。

Annotations are part of the 代码 而JavaDoc是 文档 (因此得名)。

所以对我来说,保持代码部分在一起是合情合理的。

除了编码标准之外,如果JavaDoc工具放置在注释之后,JavaDoc工具似乎不处理Java文档注释。否则工作正常。

一切都归结为可读性。在我看来,使用方法/字段正上方的注释,代码更易于阅读。