美文网首页
使用javadoc内部的文档注解

使用javadoc内部的文档注解

作者: 試毅_思伟 | 来源:发表于2020-01-20 15:49 被阅读0次

    代码示例地址:https://github.com/JoeyBling/bootplus

    1、@see

    注解@see可以在注释中实现链接跳转.@see可以指向包,类,方法,属性.

    一个完整的使用方法是这样的@see package.class#member

    • 如果指向的在当前类中,可以只写#号后面的.
    @see #field
    @see #method(Type, Type,...)
    @see #method(Type argname, Type argname,...)
    @see #constructor(Type, Type,...)
    @see #constructor(Type argname, Type argname,...)
    
    • 如果指向的在当前包中,可以省略包名.
    @see Class#field
    @see Class#method(Type, Type,...)
    @see Class#method(Type argname, Type argname,...)
    @see Class#constructor(Type, Type,...)
    @see Class#constructor(Type argname, Type argname,...)
    @see Class.NestedClass
    @see Class
    
    • 如果在其他包中,需要指向全路径.
    @see package.Class#field
    @see package.Class#method(Type, Type,...)
    @see package.Class#method(Type argname, Type argname,...)
    @see package.Class#constructor(Type, Type,...)
    @see package.Class#constructor(Type argname, Type argname,...)
    @see package.Class.NestedClass
    @see package.Class
    @see package
    

    2、{@link *}

    同上面一样的注释效果,可以链接代码

    • 但是@see必须顶头写,而{@link 可以任意地方}
    {@link StringHttpMessageConverter#readInternal(Class, HttpInputMessage)}
    

    相关文章

      网友评论

          本文标题:使用javadoc内部的文档注解

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