关于java文档注释添加url链接

因为之前没有认真系统学习过javadoc,看到@link直接认为是添加url,死活添加不上url链接,上google一查,果然理解错误,@link是为了方便注释比如我有两个方法getInt()和getInt(int i),如果getInt(int i)已经有了文档注释,那么我们可以利用@link来链接到getInt(int i)的文档注释
@link 语法
{@link package.class#member label}
而想为文档注释添加url链接可以使用@see,比如
@see <a href="http://google.com">http://google.com</a>

参考资料:
http://docs.oracle.com/javase/1.5.0/docs/tooldocs/windows/javadoc.html
http://stackoverflow.com/questions/1082050/linking-to-an-external-url-in-javadoc

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。

推荐阅读更多精彩内容

  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 135,699评论 19 139
  • 1. Java基础部分 基础部分的顺序:基本语法,类相关的语法,内部类的语法,继承相关的语法,异常的语法,线程的语...
    子非鱼_t_阅读 32,006评论 18 399
  • 本文档讲述了Java语言的编码规范,较之陈世忠先生《c++编码规范》的浩繁详尽,此文当属短小精悍了。而其中所列之各...
    蚁前阅读 4,511评论 0 51
  • 人与人最核心的关系就是信任,最难建立的也是信任!自古以来一直到千年以后,历代王朝如此、亲情如此、夫妻如此、朋友如此...
    积分制管理阅读 4,104评论 0 0
  • 才发现上个月画的一幅画忘了发上来存念,补上吧。
    偲瞳阅读 1,053评论 0 0