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

Question

将JavaDoc用于带注释的方法的推荐位置是什么？注释之前还是之后？

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

} 

OR

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

} 

Answer 1

我不认为它很重要，但第二格式更好。 annotations是代码的一部分，并根据其使用模式发挥着至关重要的作用。最好保留所有与代码相关的条目。

Answer 2

该通常风格似乎是有注释后的Javadoc评论。

原因是注释是代码的一部分，而不是文档 - 为什么文档应该放在中间。

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