简介: Java文档注解中@link与@see的使用详解 在Java编程中,良好的文档注释是代码可读性和可维护性的关键。Javadoc工具允许开发者为类、方法、字段等元素添加详细的说明文档,其中@link和@see是两个非常实用的标签,它们可以帮助读者轻松跳转到相关类、方法或字段的文档页面,极大地提升了文档的导航性和易用性。本篇...
这个时候,{@link}与@see,这2个javadoc注解就派上用场了, 不管他具体有什么功能,咱就只管一个,他可以链接代码,让注释看的更清楚易懂。方便你我他。 @see 标签允许用户引用其他类的文档。具体使用方式如下: @see fully-qualified-classname @see fully-qualified-classname#方法名称 @see fully-qualified-classname...
Java Doc -- {@link} 和 @see 使用 [toc] 一、 简介 在写Java 代码时,我们可以写代码跳转的注释,我们可以通过【command+鼠标左键】实现跳转,常用的有 {@link} 和 @see。 二、 {@link} {@link} 前面带有注释仍然可以跳转。 1. 跳转到类、方法、字段 /** * xxx * xxx {@link [package.]<class...
写代码的时候,有时候,你需要写一些注释,把内容相互关联起来,方便自己或别人看的时候,可以直接找到你关联的代码类或者啥的。 使用 {@link}与@see,这2个javadoc注解就派上用场了, @see 单独一行顶头写,如果不顶头写就不管用了,没了链接的效果 {@link}这个却可以随便放。 java_link_see.jpg...
Java--{@link}和@see--使用 简介 在写java代码时,我们可以写一些用于代码跳转或者网页跳转的注释,这样一来,我们在开发软件(比如Idea)中就可以通过ctrl+鼠标直接跳转。 常用的是{@link}和@see,两种用法基本一样,区别见下方。 {@link}和@see的区别
//单行注释 /* 单行或多行注释 */ /** *用于输出javadoc的注释形式 */ 1. 2. 3. 4. 5. JavaDoc常见参数: 官方描述: https://docs.oracle.com/javase/7/docs/technotes/tools/windows/javadoc.html @link的使用语法{@link 包名.类名#方法名(参数类型)},其中当包名在当前类中已经导入了包名可以省略...
2. 使用@link或@linkplain 只可以链接到 Java 的类、方法、字段,不可以链接到外部链接,内联到注释文本内,格式为{@link 实际地址 显示的文本},实际地址的值与上述@see中的类、字段、方法的格式相同,如果省略显示的文本,则默认显示实际地址。 例子:
@link 链接地址 链接到一个目标,用法类似@see。但常放在注释的解释中形如{@link …} 例:/***@deprecatedAs of JDK 1.1, replaced by * {@link#setBounds(int,int,int,int)}*/ 使用顺序 * @author (classes and interfaces only, required)
javadoc注释标签语法 @author对类的说明标明开发该类模块的作者@version对类的说明标明该类模块的版本@see对类、属性、方法的说明 参考转向,也就是相关主题@param对方法的说明对方法中某参数的说明@return对方法的说明对方法返回值的说明@exception对方法的说明对方法可能抛出的异常进行说明 ...
4. Java文档注释中使用@link标签的示例 java /** * 这个类演示了如何使用{@link}标签。 * * 你可以使用{@link MyClass}来链接到另一个类<br> * 或者使用{@link MyClass#myMethod()}来链接到特定方法。 */ public class ExampleClass { /** * 这是一个示例方法。 * * @see {@link Anothe...