2009-03-31 9 views
42

javadocへのリンクを書き込むにはどうすればよいですか?javadocのリンクを書くには?

現在、私のようなものがあります:java.lang.Math.sqrt(double) APIにリンクするテキストMath.sqrtを生成する

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

を、しかし、それがないすべては、テキスト、リンクなしを生産です。

+0

http://www.oracle.com/technetwork/java/javase/documentation/index-137868.html –

答えて

17

あなたのコードへの外部の何かへのリンクを取得するには、-linkofflineオプションは、このような形式のもの(人為的にラップを)持っている-linkofflineオプション

を使用する必要がありますJavaDocへのリンクを見つけるためのJavaDocツールとそのリンクを使用するパッケージ。第二URLから、それは実際のURLをロードするために、「パッケージ・リスト」を追加します:あなたは、ブラウザでそれをロードすることによって確認することができ

http://java.sun.com/javase/6/docs/api/package-list

は、JavaDocでのURLで文書化されたパッケージのリストを含んでいます。これはJavaDocツールに、@linkのいずれかのパッケージへの参照が、指定されたURLにリンクする必要があることを伝えます。

+0

あなたの正確な答えは私のためには機能しませんが、私は必要なものを私にくれました。 – masher

+2

リンクは不正な形式ではありません。@ linkの2番目の引数としてリンクラベルとして使用するテキスト文字列を指定することができます。 – mipadi

+0

@mipadi:ああ!私のJavaプログラミングのすべてにおいて、私はそれを見たことがありません。知らせてくれてありがとうございます。私は私の答えを訂正します。 – Eddie

-1

This document @linkの場合は、リンク先のドキュメントのURLを使用する必要があります。

-linkoffline http://java.sun.com/javase/6/docs/api/ 
      http://java.sun.com/javase/6/docs/api/ 

これは告げる:

+0

リンクが無効です。それで、私たちはstackoverflow(または一般的なスタック交換)にリンクを投稿しないのです。 –

+3

@linkはURL用ではありません! – Alex

20

私の答えは非常にエディによって提供されていますが、彼の正確なコードは私のために働く(あるいは、少なくとも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: warning - Error fetching 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を生成します。

+0

私は自分の答えを修正しました。あなたは正しい。 – Eddie

+0

最初の変種(URLに* package-list *を含めたもの)については、[javadoc documentation page](http:// docs。oracle.com/javase/6/docs/technotes/tools/windows/javadoc.html#linkoffline)ページにパラメータ* packagelistLoc *(引用符)が記載されています:** * package-list * filenameを含めないでください。**それはすべてそれをかなり説明する。 – informatik01

関連する問題