java {@link},Javadoc @see或{@link}？

Could someone tell me the difference between javadoc @see and {@link}?

Or rather, when to use which of them?

解决方案

The official guidelines on this are pretty clear.

The functional differences are:

{@link} is an inline link and can be placed wherever you like

@see creates its own section

In my opinion, {@link} is best used when you literally use a class, field, constructor or method name in your description. The user will be able to click through to the javadoc of what you've linked.

I use the @see annotation in 2 cases:

Something is very relevant but not mentioned in the description.

I refer to the same thing multiple times in the description, and it is used as a replacement for multiple links to the same.

I based this opinion on randomly checking out documentation for a great variety of things in the standard library.

java {@link},Javadoc @see或{@link}？相关推荐

java导出javadoc文档
一.注释 (1)文档注释的格式化生成的文档是 HTML 格式,而这些 HTML 格式的标识符并不是 javadoc 加的,而是我们在写注释的时候写上去的.比如,需要换行时,不是敲入一个回车符,而是写 ...
java中解释命令_闲来无事可来了解下Java中Javadoc命令的用法
[javadoc命令的用法] 1.java源文件里,注释以/**开始并以*/结束,里面可以包含普通文件,HTML标记和javaDoc标记.这些将构成javaDoc文档. 2.javadoc命令只能处 ...
Deep Link URL Scheme Universal Link
Deep Link & URL Scheme & Universal Link Deep Link 在移动前端,deepLink一般指app内部的逻辑处理,可以根据这个deeplink ...
Java中Javadoc的{@link}与@see的简单区别
{@link}与@see这两个Javadoc注解都可以直接链接类和方法.用法基本一致. 但是@see必须顶头写,而{@link可以任意地方},如下所示: 参考: http://blog.csdn.ne ...
开源免费 java CMS - FreeCMS-数据对象-link
2019独角兽企业重金招聘Python工程师标准>>> 下载地址:http://code.google.com/p/freecms/ link 在使用链接相关标签时,标签会封装lin ...
java中 inheritdoc,【Java】Javadoc的使用
一.名词解释 javadoc是从程序源代码中抽取类.方法.成员等注释形成一个和源代码配套的API帮助文档.也就是说,只要在编写程序时以一套特定的标签作注释,在程序编写完成后,通过Javadoc就可以 ...
java docur,JavaDoc生成API详解
一.综述 1.1 简介 Javadoc 是 Java 自带的一种工具,其可以从程序源代码中抽取类.方法.成员等注释形成一个和源代码配套的API帮助文档.也就是说,只要在编写程序时以一套特定的标记[Ta ...
Java之JavaDoc标签
javadoc工具软件识别以下标签: 标签描述示例 @author 标识一个类的作者 @author description @deprecated 指名一个过期的类或成员 @deprecated ...
php的link是什么意思,link标签有什么作用？
htmllink标签的定义和用法: 标签定义文档与外部资源的关系. 标签最常见的用途是链接样式表. html的link标签是用于当前文档引用外部文档用的,rel属性用于设置对象和链接目的间的关系.re ...

java {@link},Javadoc @see或{@link}？

java {@link},Javadoc @see或{@link}？相关推荐

最新文章

热门文章