为了让代码更清晰,我们经常使用注解。但是有些注解需要依赖其他字段或类来继续说明。这样,有个链接的话就非常方便,比如参数另一个类中的有相同前缀名的字段。
这种注释有两种, @see和{@link}
经常我会写了@×××但是无作用,其实这两个都有自己的使用场景, 比如@see必须顶头写,前边有任何文字,链接就失效
@link需要{}包围,否则也无效。
see使用
语法格式: @see 全路径包名#方法名(参数类型列表)
@see 标签允许用户引用其他类的文档。具体使用方式如下:
@see classname
@see fully-qualified-classname
@see fully-qualified-classname#方法名称
@see fully-qualified-classname#属性名称
link使用
语法格式:{@link 全路径包名#方法名(参数类型列表)}
/**
* Integer
* @see com.ecarx.base.util.PosType
* 不顶头 无链接效果@see com.ecarx.base.util.PosType
*{@link com.ecarx.base.util.PosType}
* 不顶头有链接效果{@link com.ecarx.base.util.PosType}
*/