web-dev-qa-db-ja.com

JavaDocをどのように読みますか？

JavaDocsを読むためにどのツール/ウェブサイトを使用していますか？

私は現在、J2EEプロジェクトで作業しているときに、20以上のタブを開いた状態でFirefoxを使用して、あまり使用できず、メモリを大量に消費し、検索できないすべてのドキュメントを利用できるようにしています。

私がそのようなツール/ウェブサイトに期待すること：

  • さまざまな場所からJavaDocを集約します
  • EclipseなどのCtrl + Tなどのタイプへの直接アクセス
  • 全文検索
  • 私が選択したすべてのJavaライブラリ間の相互参照
  • ツールの場合：オフラインサポート
  • 速度

必須ではありません：

  • 注釈を付ける可能性
  • ライブラリの異なるバージョンのサポート（+ diffing？）
  • IDE統合

編集：

あなたの答えをありがとう。私はほとんどのサイトを知っていましたが、もう一度試してみました。これが私の判断です：

  • 組み込みのEclipse/IDE機能
    • 緊密に統合
    • オフライン/オンラインサポート
  • javadoconline.com （メンテナンスされなくなりました）
    • 働く
    • すっきりしたルックス
    • aPIの複数のバージョンで一致を検索し、簡単に切り替えることができます
    • シンプルだが機能
    • 速い
  • jdocs （オフライン）
    • とても洗練されているようです
    • 時々遅い
    • 一部の最近のバージョンのライブラリーは欠落しているようです（Seam 2.0.0、Hibernate Validators）が、自分で追加できるようです
    • IDE統合（テストされていません）
    • 各アイテムへのwikiスタイルのコメント
  • docjar.com
    • 働く
    • 速い
    • 雑然としたUI
  • javadoc_isearch
    • javadocsのナビゲートを容易にするFirefox用のgreasemonkeyスクリプト
    • スムーズかつ完璧に動作します
javadocumentationjavadoc
30
jrudolph

Eclipseを使用する場合、Javadocのサポートを提供します。たとえば、メソッド呼び出しの上にマウスを置くと、そのメソッドのJavadocを示すツールチップが表示されます。コアのドキュメントJavaクラスはそのまま使用できます。ただし、プロジェクトで追加のライブラリ（JARファイル）を使用する場合、JavadocをEclipseにプラグインするためにいくつかの構成が必要です。

  1. プロジェクトプロパティの「Javaビルドパス」セクションに移動します。
  2. 「ライブラリ」タブに移動し、JARファイルの横にある「プラス」アイコンをクリックします。
  3. 「Javadocの場所」をクリックしてから、「編集...」ボタンをクリックします。

これにより、そのJARのJavadocの場所を指定できます。 WebサイトのURLを指定することもできるので、Javadocを自分でダウンロードする必要はありません。

9
Michael

私はこれのために私自身のツールを書きました。私の同僚によれば、彼らが見たのが一番です。

Luceneで1回インデックスを作成し、バックグラウンドで小さなサーバーを実行するので、ブラウザーのようにjavadocs（pydocs、perldocs ..）を閲覧できます。また、言語ごとに個別のライブラリを使用できるため、「biginteger」やsimialrなどの検索が失敗することはありません。

https://github.com/judovana/JavadocOfflineSearch/releases

2
judovana

スタンフォード大学のJavaDoc here を見つけることができます。

2
Léo Léopold Hertz 준영

JavaDocjarは直接解凍できます。理論的には、リリースされたjavadocはダウンロードしてオフラインで表示できます。

  1. mavenリポジトリから直接ダウンロードします。例： http://central.maven.org/maven2/com/googlecode/objectify/objectify/5.0.3/objectify-5.0.3-javadoc.jar

  2. これでobjectify-5.0.3-javadoc.jarが得られ、ファイルの名前をobjectify-5.0.3-javadoc.Zipに変更します。

  3. お気に入りの解凍ツールを使用して解凍すると、objectify-5.0.3-javadocフォルダーが作成されます。

  4. index.htmlをダブルクリックすると、デフォルトのブラウザでインデックスページが開きます。

2
Max

私はFFに http://www.teria.com/~koseki/tools/gm/javadoc_isearch/ を使用します。他のライブラリも簡単に閲覧できます。

2
Swati

Firefox用のこのプラグインとChromeは、パッケージ名とクラス名をすばやく見つけるのに役立ちますが、全文検索ではありません： https://code.google.com/p/ javadoc-search-frame /

1
Glenn Lawrence

EclipseはJavadocとうまく統合され、HTMLのようなビューアを備えています。クラスを選択すると表示されるバイナリにソースとjavadocを添付できます。

1
Heath Borders

このような何かが役に立つかもしれませんか？

http://www.docjar.com/

1
user7094

個人的には、IDEが提供する組み込みのjavadocブラウジングツールで問題が発生したことがありません。

現在、私はIntelliJアイデアを使用しています-Ctl-Qはカーソルの下にあるメソッドのjavadocを表示し、ドキュメントの他の部分へのハイパーリンクを機能させます。

NetBeansとEclipseが同様の機能を提供していると思います。

1
Rob Dickerson

うーん...どうですか：

  • http://edu.netbeans.org/quicktour/javadoc.html --NetBeansは、Javaドキュメント-表示と生成の両方について、Javadoc標準をサポートしています。
  • http://globaldocs.zeevbelkin.com/ -このアプリケーションを使用すると、単一のパッケージ/クラス階層ツリーと検索可能なインデックスを使用して、インターネットとローカルファイルシステムを介して複数のjavadocセットを簡単に参照できます。ビューアはローカルおよびリモートのドキュメントセットをサポートしています（JAR/Zipファイルにパックされたローカルのドキュメントセットもサポートされています）。

Maven~/.m2ディレクトリから自動的にJavaDocを取得するので、NetBeansを好みます...

1
gavenkoa

Doxygen（ http://www.doxygen.nl/ ）は法案に合うかもしれません。

編集：私はあなたの質問を読み間違えたかもしれません、doxygenはあなたのコードとjavadocに基づいてドキュメントとモデルを生成するためのツールです。

0
mmattax

Eclipseは、javadocsを表示するための最良の方法です。メソッドまたは宣言にマウスを合わせると、Eclipseによって自動的に生成されたjavadocsが表示されます。

0
Rohit deol