首页
学习
活动
专区
工具
TVP
发布
精选内容/技术社群/优惠产品,尽在小程序
立即前往

在Javadoc中使用@link和@see

是为了在文档中创建链接,以便于查看相关的类、方法或者其他文档。

@link标签用于创建一个链接到指定的类、方法或者其他文档。它可以用于在文档中引用其他类或者方法的名称,并且可以通过点击链接直接跳转到相关的文档。使用@link标签时,需要在标签后面紧跟着要链接的类或者方法的全名,包括包名和类名或者方法名。

例如,假设我们有一个名为"com.example.MyClass"的类,我们可以在Javadoc中使用@link标签来引用它:

{@code

/**

  • This is a sample class that demonstrates the usage of the {@link com.example.MyClass}. */ public class AnotherClass { // ... } }

在上面的例子中,{@link com.example.MyClass}会创建一个链接到"com.example.MyClass"类的文档。

@see标签用于创建一个链接到其他相关的文档。它可以用于引用其他类、方法或者其他文档,以提供更多的相关信息。与@link标签不同的是,@see标签可以引用其他文档的简单名称,而不需要包括完整的包名和类名。

例如,假设我们有一个名为"com.example.MyClass"的类,我们可以在Javadoc中使用@see标签来引用它:

{@code

/**

  • This is a sample class that demonstrates the usage of the {@see MyClass}. */ public class AnotherClass { // ... } }

在上面的例子中,{@see MyClass}会创建一个链接到"com.example.MyClass"类的文档。

总结起来,@link和@see标签都是用于在Javadoc中创建链接的标签。@link标签用于引用其他类或者方法的全名,而@see标签用于引用其他文档的简单名称。这些标签可以提供更多的相关信息,方便开发者在阅读文档时快速查找和跳转到相关的内容。

腾讯云相关产品和产品介绍链接地址:

页面内容是否对你有帮助?
有帮助
没帮助

相关·内容

领券