JavaDoc应该在方法级注释之前还是之后？

Question

将JavaDoc放入带注释的方法的推荐位置是什么？注释之前或之后？

@Test
/**
 * My doc
 */
public void testMyTest(){

}

OR

/**
 * My doc
 */
@Test
public void testMyTest(){

}

Answer 1

我认为这不重要，但第二种格式更好。 annotations是代码的一部分，并根据其使用模式发挥关键作用。最好将所有与代码相关的条目保持在一起。

Answer 2

通常的样式似乎是在注释

之后注释。

原因是注释是代码的一部分，而不是文档的一部分 - 为什么文档应该介于两者之间。

对于@Override和@Test，这可能并不明显，当然也有与文档相关的注释。但从技术上讲，注释是特定语法的 Java代码。