代码风格；将 javadoc 放在注释之前还是之后? [英] codestyle; put javadoc before or after annotation?

问题描述

我知道这不是最重要的问题，但我刚刚意识到我可以在注释之前或之后放置 javadoc 注释块.我们希望采用什么作为编码标准?

I know that it isn't the most vital of issues, but I just realised that I can put the javadoc comment block before or after the annotation. What would we want to adopt as a coding standard?

/**
 * This is a javadoc comment before the annotation 
 */
@Component
public class MyClass {

    @Autowired
    /**
     * This is a javadoc comment after the annotation
     */
    private MyOtherClass other;
}

推荐答案

在注解之前，因为注解是属于"类的代码.请参阅官方文档中的javadoc 示例.

Before the annotation, since the annotation is code that "belongs" to the class. See examples with javadoc in the official documentation.

这是我在 另一个官方文件中找到的随机示例Java页面:

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

这篇关于代码风格；将 javadoc 放在注释之前还是之后?的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！