Java @link 注释

最新推荐文章于 2025-06-09 22:03:44 发布

大脸猫6_6

最新推荐文章于 2025-06-09 22:03:44 发布

阅读量1.6w

点赞数 5

CC 4.0 BY-SA版权

分类专栏： Java 文章标签： java

本文链接：https://blog.youkuaiyun.com/bigfc/article/details/126473213

Java 专栏收录该内容

3 篇文章

订阅专栏

本文详细介绍了如何利用JavaDoc注释提高代码可读性，包括@link、@see、HTML的<a>标签以及@plainlink的用法，并通过示例展示了它们在注释链接类、方法、属性等方面的应用。了解这些技巧能帮助开发者更好地编写和理解代码。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

开发过程中多多使用Java Doc注释，可以很大程度的提高代码可阅读性，这是一种很好的编码习惯。

一、@link 语法

/**
 *
 * {@link  [包名].<类名>#[方法|属性] }
 *
 */

示例：

/**
 * 链接:其它包的类 {@link com.zhn.learn_android.other.ClassB }
 *
 * 链接:同包的类（可以省略包名） {@link ClassA }
 * 链接:同包类的成员 {@link ClassA#name }
 * 链接:同包类的方法 {@link ClassA#print() }
 *
 * 链接:同包类的内部类 {@link ClassA.SubClassA }
 * 链接:同包类的内部类-的成员 {@link ClassA.SubClassA#id }
 *
 * 链接:当前类的方法 {@link #test() }
 *
 * 链接:接口的常量 {@link Constants#CLIENT_TYPE }
 *
 */
public class TestJavaDoc {
    /**
     * 链接:同包的类 {@link ClassA }
     */
    public void test(){

    }
}

二、@see 语法

与@link相比，@see 前面不能加其它注释，也不需要{}包裹。

/**
 *
 * @see  [包名].<类名>#[方法|属性] 
 *
 */

示例：

/**
 * @see com.zhn.learn_android.other.ClassB
 *
 * @see ClassA
 * @see ClassA#name
 * @see ClassA#print()
 *
 * @see ClassA.SubClassA
 * @see ClassA.SubClassA#id
 *
 * @see #test()
 *
 * @see Constants.GOODS_ID
 *
 */
public class TestJavaDoc {

    /**
     * @see ClassA
     */
    public void test(){

    }
    
}

三、<a> 标签

Java Doc 注释中可以添加Html的a标签，点击可以打开链接，如下：

/**
 *
 * <a href="https://www.baidu.com" />
 *
 */
public class TestJavaDoc {

}

四、@linkplain

与@link相比多了一个参数“别名”，用于生成java doc时显示。

/**
 *
 * {@linkplain  [包名].<类名>#[方法|属性]  别名 }
 *
 */

相较之下，个人还是比较喜欢直接使用@link。

注：

1、被/** */ 包括的注释才是Java Doc 注释，其中的@link 等Java Doc 标签才能被识别，//和/* */中是不识别的。

2、添加在类、方法、属性上皆可以。

3、@link @see 都链到私有属性或方法时，会显示错误，但是仍然可以点击跳转。