javadoc

javadoc

@link：{@link 包名.类名#方法名(参数类型)} 用于快速链接到相关代码

// 完全限定的类名
{@link java.lang.Character}

// 省略包名
{@link String}

// 省略类名，表示指向当前的某个方法
{@link #length()}

// 包名.类名.方法名(参数类型)
{@link java.lang.String#charAt(int)}

---

@see 另请参阅

@see 一般用于标记该类相关联的类,@see即可以用在类上，也可以用在方法上。

/**
 * @see IntStream
 * @see LongStream
 * @see DoubleStream
 * @see <a href="package-summary.html">java.util.stream</a>
 * /
public interface Stream<T> extends BaseStream<T, Stream<T>> {}

---

@version 版本

@version 用于标记当前版本，默认为1.0

package com.sun.org.apache.xml.internal.resolver;
 /**
 * @version 1.0
 */
public class Resolver extends Catalog {}

---

@return

@return 跟返回值的描述

/**
 * @return {@code true} if the {@code String} is not {@code null}, its
 */
public static boolean hasText(@Nullable String str){}

---

---

@code： {@code text} 将文本标记为code

{@code text} 会被解析成<code> text </code>
将文本标记为代码样式的文本，在code内部可以使用 < 、> 等不会被解释成html标签, code标签有自己的样式

一般在Javadoc中只要涉及到类名或者方法名，都需要使用@code进行标记。

第二段：详细描述
详细描述一般用一段或者几个锻炼来详细描述类的作用，详细描述中可以使用html标签，如<p>、<pre>、<a>、<ul>、<i>等标签， 通常详细描述都以段落p标签开始。
详细描述和概要描述中间通常有一个空行来分割

---

@param

一般类中支持泛型时会通过@param来解释泛型的类型
/**
 * @param <E> the type of elements in this list
 */
public interface List<E> extends Collection<E> {}

---

@author

详细描述后面一般使用@author来标记作者

// 纯文本作者，邮件
@author Igor Hersht, igorh@ca.ibm.com

---