如何在Javadoc中从另一个评论位置创建超链接？

Question

我可以为代码中的某个评论块编写超链接/链接，以便在代码的任何部分引用。

例如，我已经在类的顶部提到了一些注释：

  /**
   * Really long comments with some case based detail
   */
    //Code goes here...
    //Code goes here...

// Hey I want you to please have a look at **This Comments** please before making any changes ...
public void myMethod(){....

// Hey I want you to please have a look at **This Comments** please before making any changes ...
public void yetAnotherMethod(){....

For above the **This Comments** should be a link to details mentioned at the top.

- Sankalp

Answer 1

引用/链接

您可以使用 @link 和 @see javadoc 标签来插入到另一个类型或字段的链接。

您还可以像这样指定链接的文本：

{@link ClassName#fieldName Text to display}

@see ClassName#fieldName Text to display

示例：

我使用了一个字段来定义评论，但是您也可以链接到类、方法、字段等：

/**
 * Important to know that...
 */
private static final byte IMPORTANT_NOTE = 0;

/**
 * Before making changes, see {@link #IMPORTANT_NOTE Important note}.
 */
public void myMethod() {}

/**
 * @see #IMPORTANT_NOTE Important to check this!
 */
public void myMethod2() {}

内联

您还可以使用@value将静态字段的值内联到javadoc中，例如：

private static final String IMPORTANT_NOTE = "Important to know that...";

/**
 * See this important note: {@value #IMPORTANT_NOTE}
 */
public void myMethod() {}

- icza

---

谢谢@icza，但实际上这听起来像是一个hack，因为它总是需要保持一个静态的虚拟变量。仍在寻找更多的方法来解决这个问题。 - Sankalp

这在我的情况下不起作用。我的意思是它没有变成链接。 - Abdul Waheed