Java @请参见标记,链接其他类和方法
例如,我想使用html标记链接java.lang.Double的equals方法:Java @请参见标记,链接其他类和方法,java,javadoc,netbeans-7,Java,Javadoc,Netbeans 7,例如,我想使用html标记链接java.lang.Double的equals方法: @see <a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/Double.html#equals(java.lang.Object)"> 这不会放置类URL,在生成文档之前,我知道如何获取URL或其引用。 我希望问题是清楚的,请告诉我其他情况。javadoc手册页解释了-link和-linkoffline,它们控制如何为未
@see <a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/Double.html#equals(java.lang.Object)">
这不会放置类URL,在生成文档之前,我知道如何获取URL或其引用。我希望问题是清楚的,请告诉我其他情况。javadoc手册页解释了
-link
和-linkoffline
,它们控制如何为未传递到javadoc的包生成链接
-link extdocURL
Creates links to existing javadoc-generated documentation
of external referenced classes. It takes one argument.
extdocURL is the absolute or relative URL of the directory
containing the external javadoc-generated documentation
you want to link to. Examples are shown below. The pack-
age-list file must be found in this directory (otherwise,
use -linkoffline). The Javadoc tool reads the package
names from the package-list file and then links to those
packages at that URL. When the Javadoc tool is run, the
extdocURL value is copied literally into the <A HREF>
links that are created. Therefore, extdocURL must be the
URL to the directory, not to a file.
You can use an absolute link for extdocURL to enable your
docs to link to a document on any website, or can use a
relative link to link only to a relative location. If rel-
ative, the value you pass in should be the relative path
from the destination directory (specified with -d ) to the
directory containing the packages being linked to.
When specifying an absolute link you normally use an http:
link. However, if you want to link to a file system that
has no web server, you can use a file: link - however, do
this only if everyone wanting to access the generated doc-
umentation shares the same file system.
You can specify multiple -link options in a given javadoc
run to link to multiple documents.
Choosing between -linkoffline and -link - One or the other
option is appropriate when linking to an API document that
is external to the current javadoc run.
Use -link: when using a relative path to the external API
document, or when using an absolute URL to the external
API document, if you shell does not allow a program to
open a connection to that URL for reading.
Use -linkoffline : when using an absolute URL to the
external API document, if your shell does not allow a pro-
gram to open a connection to that URL for reading. This
can occur if you are behind a firewall and the document
you want to link to is on the other side.
...
要创建到特定类的标记,可以使用{@link mypackage.AbstractVehicle}
标记。同样,您可以使用{@link mypackage.AbstractVehicle#somethod}
在AbstractVehicle
类中创建指向somethod()
的链接
更多的javadoc推荐可以在Oracle的页面上找到。您可以在@see
之后放置的内容在中介绍。您不应该放置任何外部类或方法文档的URL。相反,您应该输入类/方法名,并使用让javadoc为您找出合适的URL 如果JavaDoc被添加到同一个包中的不同类中,是否需要指定完整的包名?
-link extdocURL
Creates links to existing javadoc-generated documentation
of external referenced classes. It takes one argument.
extdocURL is the absolute or relative URL of the directory
containing the external javadoc-generated documentation
you want to link to. Examples are shown below. The pack-
age-list file must be found in this directory (otherwise,
use -linkoffline). The Javadoc tool reads the package
names from the package-list file and then links to those
packages at that URL. When the Javadoc tool is run, the
extdocURL value is copied literally into the <A HREF>
links that are created. Therefore, extdocURL must be the
URL to the directory, not to a file.
You can use an absolute link for extdocURL to enable your
docs to link to a document on any website, or can use a
relative link to link only to a relative location. If rel-
ative, the value you pass in should be the relative path
from the destination directory (specified with -d ) to the
directory containing the packages being linked to.
When specifying an absolute link you normally use an http:
link. However, if you want to link to a file system that
has no web server, you can use a file: link - however, do
this only if everyone wanting to access the generated doc-
umentation shares the same file system.
You can specify multiple -link options in a given javadoc
run to link to multiple documents.
Choosing between -linkoffline and -link - One or the other
option is appropriate when linking to an API document that
is external to the current javadoc run.
Use -link: when using a relative path to the external API
document, or when using an absolute URL to the external
API document, if you shell does not allow a program to
open a connection to that URL for reading.
Use -linkoffline : when using an absolute URL to the
external API document, if your shell does not allow a pro-
gram to open a connection to that URL for reading. This
can occur if you are behind a firewall and the document
you want to link to is on the other side.
...
-linkoffline extdocURL packagelistLoc
This option is a varition of -link; they both create links
to javadoc-generated documentation for external referenced
classes. Use the -linkoffline option when linking to a
document on the web when the Javadoc tool itself is
"offline" - that is, it cannot access the document through
a web connection.
...