javadoc にリンクを書き込むにはどうすればよいですか?
現在、私は次のようなものを持っています:
{@link java.lang.Math#sqrt(double) Math.sqrt}
Math.sqrt
API にリンクする必要があるテキストを生成するためにjava.lang.Math.sqrt(double)
、ただし、テキストを生成するだけで、リンクは生成しません。
私の答えは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
Math.sqrt(double)
-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 で文書化されたパッケージのリストが含まれています。@link
これにより、これらのパッケージの 1 つにあるものへの参照はすべて、指定された URL にリンクする必要があることが JavaDoc ツールに伝えられます。
このドキュメントが役立つ場合があります。@link には、リンク先のドキュメントの URL を使用する必要があることに注意してください。