javadoc中的{@link }和{@linkplain }标签

简单记录一下这两个标签的用法。

共同之处:在javadoc文档中创建一个指向另一份文档的超链接。

区别:
{@link }将超链接的“地址”当做其文本。如:

此实现继承了{@link com.sinosig.saab.service.impl.BaseManagerImpl},以复用其中的dao接口


将显示为:

最后,此实现继承了com.sinosig.saab.service.impl.BaseManagerImpl,以复用其中的dao接口

而{@linkplain }标签除了设定超链接的“地址”之外,还可以设定其文本。格式是:
{@linkplain 地址 文本},三个字段以空格隔开即可。如

使用方法与 {@linkplain com.sinosig.atip.common.simpledb.web.SimpleDBAction SimpleDBAction} 基本一致

将显示为:

使用方法与 SimpleDBAction 基本一致

总的来说,{@link }使用更简单,{@linkplain }显示更合理、漂亮。


本文转自 斯然在天边 51CTO博客,原文链接:http://blog.51cto.com/winters1224/875466,如需转载请自行联系原作者
上一篇:JavaWeb学习之路(22)–HTML之表单与输入标签


下一篇:JAVA序列化 Serializable 将对象转为数组,再反过来将数组转为对象