web-dev-qa-db-ja.com

@マーカーを参照、他のクラスのメソッドをリンク

たとえば、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またはその参照を取得する方法を知っています。
質問が明確であることを願っています。そうでない場合は教えてください。

javajavadocnetbeans-7
13
Ramy Al Zuhouri

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

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

13
matsev

Javadocのマンページでは、-linkおよび-linkofflinejavadocに渡されないパッケージのリンクの生成方法を制御します。

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

          ...
3
Mike Samuel

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

2
JB Nizet