【发布时间】：2012-11-03 07:05:47
【问题描述】：
对于带有注解的方法，建议将 JavaDoc 放在什么位置？注释之前还是之后？
@Test
/**
* My doc
*/
public void testMyTest(){
}
或
/**
* My doc
*/
@Test
public void testMyTest(){
}
【问题讨论】：
标签： java coding-style annotations javadoc
【发布时间】：2012-11-03 07:05:47
【问题描述】：
我认为这并不重要，但第二种格式更好。 annotations 是代码的一部分，并根据其使用模式发挥关键作用。最好将所有与代码相关的条目放在一起。
【讨论】：
-
如果注释是代码的一部分，注释可以包含在javadoc中吗？
-
@Freiheit：是的，例如
/** * This is my custom method. * @param param1 * @param param2 * @return outParam1 * @throws BusinessException */。但在这种情况下，它们不是代码的一部分。 -
不是我要问的，请考虑我问题中的示例。是否有 JavaDoc 表明我正在使用 @Test 注释？
-
@Freiheit：由于它是代码的一部分，我不认为它直接支持Java Doc Specifications，但我认为您可以根据需要创建一个taglet。
通常的样式似乎是在 Javadoc 注释之后添加注释。
原因是注释是代码的一部分，而不是文档的一部分 - 为什么文档应该位于两者之间。
这对于@Override 和@Test 可能并不明显，当然也有与文档相关的注释。但从技术上讲，注解是具有特定语法的 Java 代码。
【讨论】：