codestyle;在注释之前或之后放入javadoc？

148

我知道这不是最重要的问题，但我意识到我可以在注释之前或之后放置javadoc注释块。我们希望采用什么作为编码标准？codestyle;在注释之前或之后放入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; 
}

来源

2010-06-24 Paul McKenzie

158

在注解之前，由于注释是“属于”类的代码。请参阅官方文档中的examples with javadoc。

这里是随便举个例子我在another official Java page发现：

/** 
* 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) { 
    ... 
}

来源

2010-06-24 12:37:00

此处也有趣 - 注释与方法的其他限定符位于同一行。我从来没有见过这样做，但似乎表明注释应该像对其他方法的限定符一样对待，因此，javadoc应该一直在它之前。 – ArtOfWarfare 2013-11-06 18:42:09

如果您使用像Jackson这样的重要注记，那么将相同的注释放在同一行上可能会很快失控。我把每个注释放在它自己的一行上。 – 2015-04-10 02:43:52

这一切都归结到可读性 - 。在我看来，直接在方法/字段之上的注释使得代码更具可读性。

来源

2010-06-24 12:38:22

我同意已经给出的答案。

注解是代码而javadoc的是文档（因此命名）的一部分的一部分。

所以对我来说它合理的代码部分保持在一起。

来源

2010-06-24 13:05:01 perdian

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

来源

2013-10-25 08:49:37 shadrik

codestyle;在注释之前或之后放入javadoc？

回答

相关问题