编码把javadoc放在注释之前或之后? [英] codestyle; put javadoc before or after annotation?

查看:205
本文介绍了编码把javadoc放在注释之前或之后?的处理方法,对大家解决问题具有一定的参考价值,需要的朋友们下面随着小编来一起学习吧!

问题描述

我知道这不是最重要的问题,但我只是意识到,我可以把注释之前或之后的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屋!

查看全文
登录 关闭
扫码关注1秒登录
发送“验证码”获取 | 15天全站免登陆