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

Question

为带有注解的方法放置 JavaDoc 的推荐位置是什么？注释之前还是之后？

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

}

或者

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

}

Answer 1

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

Answer 2

通常的样式似乎是在 Javadoc注释之后有注释。

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

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