使用javadoc内部的文档注解

2020-01-20  本文已影响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 *}

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

{@link StringHttpMessageConverter#readInternal(Class, HttpInputMessage)}
上一篇下一篇

猜你喜欢

热点阅读