Javadoc注释学习
以前写程序的时候,没有太注意过这些,当然也会加注释,但是从来没有系统的学习过、使用过javadoc的注释,今天补一补。
具体使用看下面的参考链接,我基本看明白基本的使用了,以后开发的时候会注意一下。
http://caoyaqiang.diandian.com/post/2012-08-27/40038608447
http://liheyuan.bj.blog.163.com/blog/static/11802605620094254757372/
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 }显示更合理、漂亮。