美文网首页
注释诀窍

注释诀窍

作者: zhongjh | 来源:发表于2017-06-06 15:05 被阅读10次

    ** JavaDoc 标 记**

    ** 解释 **

    @version

    指定版本信息

    @since

    指定最早出现在哪个版本

    @author

    指定作者

    @see

    生成参考其他的JavaDoc文档的连接

    @link

    生成参考其他的JavaDoc文档,它和@see标记的区别****在于,@link标记能够嵌入到注释语句中,为注释语句中的****特殊词汇生成连接。 eg.{@link Hello}

    @deprecated

    用来注明被注释的类、变量或方法已经不提倡使用,在将来****的版本中有可能被废弃

    @param

    描述方法的参数

    @return

    描述方法的返回值

    @throws

    描述方法抛出的异常,指明抛出异常的条件

    /**
    * 传递类型 @{@link com.yaoguang.appcommon.util.ConstantUtil#TYPE_COMPANY }
    * */
    private String mType = "";

    相关文章

      网友评论

          本文标题:注释诀窍

          本文链接:https://www.haomeiwen.com/subject/hongfxtx.html