在写代码的注释时,有时需要把内容相互关联起来,方便在查看的时候,可以直接指向其他的类、属性或方法。比如@deprecated标记的类,需要指向推荐使用的新类时,该注解就很有用了。说白了,他就是可以链接指向代码,让我们的注释更清晰易懂。可以指向包、类、方法、属性。
@see注解的使用方法:
@see classname
@see fully-qualified-classname
@see fully-qualified-classname#方法名称
@see fully-qualified-classname#属性名称
注意@see注解需要顶着行首写,不然就无效了,没有链接的效果了。而{@link}却可以放在任何地方,两者实际效果一样。如下:
/**
* 测试代码
* {@link com.sf.model.CsdModel}
* 不顶着行首写也可以 {@link com.sf.model.CsdModel}
* 不顶着行首写也可以 {@link com.sf.model.CsdMode#namel}
* 不顶着行首写也可以 {@link CsdMode#namel}
*
* @see com.sf.model.CsdMode
* @see CsdMode
* 不顶行首写 无效了 @see com.sf.model.CsdMode
*/