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;
}

---

在注解之前，由于注释是“属于”类的代码。 在官方文档中查看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是文档的一部分（因此名称）。

因此，对于我来说，它合理地将代码部分保存在一起。

---

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

链接地址: http://www.djcxy.com/p/88757.html

上一篇: codestyle; put javadoc before or after annotation?

下一篇: HTML vs XHTML