如何编写javadoc链接?
我如何写入链接到javadocs?
目前,我有这样的东西:
{@link java.lang.Math#sqrt(double) Math.sqrt}
生成应该链接到java.lang.Math.sqrt(double)
API的文本Math.sqrt
,但是它所做的只是生成文本,没有链接。
要获得到代码外部的链接,您需要使用-linkoffline
选项
其中-linkoffline
选项的格式是这样的(人为包装):
-linkoffline http://java.sun.com/javase/6/docs/api/ http://java.sun.com/javase/6/docs/api/
这告诉JavaDoc工具在哪里可以find到JavaDoc的链接以及使用该链接的软件包。 从第二个URL,它将追加“包列表”加载实际的URL:
http://java.sun.com/javase/6/docs/api/package-list
您可以通过将其加载到浏览器来validation它是否包含在该JavaDoc URL中logging的软件包列表。 这告诉JavaDoc工具,任何@link
引用其中一个包中的任何内容都应链接到提供的URL。
我的答案是Eddie提供的,但是他的确切的代码不适用于我(或者至less在使用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:警告 - 获取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)
。
这个文档可能有帮助,请记住,对于@link,您需要使用您要链接到的文档的URL。