Question

比方说，我想用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)">

这没关系，但我还不知道如何链接非标准类例如，我正在开发两个类，名为AbstractVehicle和Vehicle.But没有AbstractVehicle的javadoc文档，因为它的文档仍然需要生成。
然后我如何链接它的方法或类引用？考虑一下：

@see mypackage.AbstractVehilce

这不会放置类URL，我会在生成文档之前知道如何获取URL或它的引用。
我希望问题很清楚，不然告诉我。

Answer 1

要为特定课程创建link，您可以使用{@link mypackage.AbstractVehicle}标记。同样，您可以使用{@link mypackage.AbstractVehicle#someMethod}在someMethod()课程中创建指向AbstractVehicle的链接。

更多javadoc建议可以在Oracle的javadoc - The Java API Documentation Generator页面找到。

Answer 2

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要求您在生成文档时进行网络连接，以便它可以通过网络检索包列表，-linkoffline不会，但要求您自己提供包列表：< / p>

   -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.

          ...

Answer 3

在javadoc tool documentation中描述@see后可以放置的内容。您永远不应该放置任何外部类或方法文档的URL。相反，您应该放置类/方法名称，并使用-link option让javadoc为您找出适当的URL。

@see marker，链接其他类方法

3 个答案: