Warning: file_get_contents(/data/phpspider/zhask/data//catemap/5/bash/15.json): failed to open stream: No such file or directory in /data/phpspider/zhask/libs/function.php on line 167

Warning: Invalid argument supplied for foreach() in /data/phpspider/zhask/libs/tag.function.php on line 1116

Notice: Undefined index: in /data/phpspider/zhask/libs/function.php on line 180

Warning: array_chunk() expects parameter 1 to be array, null given in /data/phpspider/zhask/libs/function.php on line 181
如何在javadoc中从另一个注释位置超链接一个注释_Java_Formatting_Documentation_Comments_Javadoc - Fatal编程技术网

如何在javadoc中从另一个注释位置超链接一个注释

如何在javadoc中从另一个注释位置超链接一个注释,java,formatting,documentation,comments,javadoc,Java,Formatting,Documentation,Comments,Javadoc,我想为我可以从代码的任何部分引用的注释块编写一个超链接/链接 例如,我在课堂上提到了一些评论: /** * 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 c

我想为我可以从代码的任何部分引用的注释块编写一个超链接/链接

例如,我在课堂上提到了一些评论:

  /**
   * 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.
引用/链接 您可以使用
@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,但实际上这听起来像是一个黑客,因为它总是需要为此保留一个静态虚拟变量。仍然在寻找更多的方法来做到这一点。这在我的情况下不起作用。我的意思是它没有转向链接