13

たとえば、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 という名前の 2 つのクラスを開発していますが、AbstractVehicle の javadoc ドキュメントはまだ生成されていないため、ありません。
次に、そのメソッドまたはクラス参照をリンクするにはどうすればよいですか? このことを考慮:

@see mypackage.AbstractVehilce

これはクラス URL を入れません。ドキュメントを生成する前に、URL またはその参照を取得する方法を知っています。
質問が明確であることを願っています。そうでない場合は教えてください。

4

3 に答える 3

13

特定のクラスへのリンクを作成するには、{@link mypackage.AbstractVehicle}タグを使用できます。同様に、クラス内{@link mypackage.AbstractVehicle#someMethod}へのリンクを作成するために使用できます。someMethod()AbstractVehicle

その他の javadoc の推奨事項は、Oracle のjavadoc - The Java API Documentation Generatorページにあります。

于 2012-04-29T17:55:31.910 に答える
3

javadoc のマンページでは、-linkおよび-linkofflinewhich コントロールが に渡されないパッケージのリンクを生成する方法について説明しています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必要がありますが、パッケージリストを自分で提供する必要はありません。

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

          ...
于 2012-04-29T17:49:30.720 に答える
2

後に置くことができるものは、 javadoc ツールのドキュメント@seeに記載されています。外部クラスまたはメソッドのドキュメントの URL を入力しないでください。代わりに、クラス/メソッド名を入力し、-link オプションを使用して、javadoc が適切な URL を見つけられるようにする必要があります。

于 2012-04-29T17:55:45.333 に答える