web-dev-qa-db-ja.com

javadocリンクの書き方

Javadocsにリンクを書き込むにはどうすればよいですか？

現在、私は次のようなものを持っています：

_{@link Java.lang.Math#sqrt(double) Math.sqrt}
_

Java.lang.Math.sqrt(double) AP​​Iにリンクする必要があるテキスト_Math.sqrt_を作成しますが、テキストを作成するだけで、リンクは作成しません。

hyperlinkjavadoc
44
masher

コードの外部へのリンクを取得するには、-linkofflineオプション

どこ -linkofflineオプションの形式は次のようなものです（人工的にラップされています）。

-linkoffline http://Java.Sun.com/javase/6/docs/api/
             http://Java.Sun.com/javase/6/docs/api/

これは、JavaDocへのリンクを見つける場所と、そのリンクを使用するパッケージについてJavaDocツールに指示します。 2番目のURLから、「package-list」を追加して実際のURLをロードします。

http://Java.Sun.com/javase/6/docs/api/package-list

ブラウザに読み込むことで確認できますが、そのJavaDoc URLで文書化されたパッケージのリストが含まれています。これは、JavaDocツールに@linkこれらのパッケージのいずれかへの参照は、指定されたURLにリンクする必要があります。

19
Eddie

私の答えはEddieによって非常に提供されますが、彼の正確なコードは私には機能しません（少なくとも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(double)の代わりにリンクテキストMath.sqrtを生成します。

21
masher