代码之家  ›  专栏  ›  技术社区  ›  masher

如何编写javadoc链接?

  •  44
  • masher  · 技术社区  · 16 年前

    {@link java.lang.Math#sqrt(double) Math.sqrt}
    

    生成文本 Math.sqrt java.lang.Math.sqrt(double)

    4 回复  |  直到 13 年前
        1
  •  19
  •   Eddie    16 年前

    我的答案主要由Eddie提供,但他的确切代码对我不起作用(或者至少在使用Java 1.6附带的javadoc版本时)

    如果我这样做:

        javadoc -linkoffline http://java.sun.com/javase/6/docs/api/ 
                             http://java.sun.com/javase/6/docs/api/package-list
                -public FileName.java

    然后javadoc抱怨:

        javadoc: warning - Error fetching URL: 
        http://java.sun.com/javase/6/docs/api/package-list/package-list

    另一方面,如果我这样做:

        javadoc -linkoffline http://java.sun.com/javase/6/docs/api/ 
                             http://java.sun.com/javase/6/docs/api/ 
                -public FileName.java

    然后它工作了,我的链接按照我想要的方式填充。

    {@link java.lang.Math#sqrt(double) Math.sqrt} 生成链接文本 Math.sqrt 而不是默认值 Math.sqrt(double) .

        2
  •  21
  •   masher    16 年前

    -linkoffline 选项

    -离线链接 选项的格式类似于这样(人工包装):

    -linkoffline http://java.sun.com/javase/6/docs/api/
                 http://java.sun.com/javase/6/docs/api/
    

    这告诉JavaDoc工具在哪里找到指向JavaDoc的链接,以及使用该链接的包。从第二个URL开始,它将附加“包列表”以加载实际的URL:

    http://java.sun.com/javase/6/docs/api/package-list

    您可以通过在浏览器中加载它来验证它是否包含该JavaDoc URL中记录的包列表。这告诉JavaDoc工具 @link

        3
  •  -1
  •   Martin Spamer    12 年前

    @see java.lang.Math#sqrt(double)
    

    你也可以编写一个更通用的链接,比如使用标准的html:

    <a href="http://www.google.com">Google</a>