web-dev-qa-db-ja.com

より良いJavaDoc?

標準のJavaDocテンプレート(Doclet)は、最近のJDK7まであまり変更されていません。私の意見では、JDK7テンプレートは閲覧をさらに困難にするだけでした。サードパーティのドックレットをいくつか調べましたが、どれも欲しいものではありません。そこで、使いやすさを向上させるために、新しいオープンソースのJavaDocテンプレートを最初から設計し始めました。これが私が考えたことです、

  • 検索中。ローカルファイルシステムで機能させるには、クライアント側で実行する必要があります。
  • IDEのようなインタラクティブナビゲーション。標準のJavaDocは、2つのフレームを使用してパッケージとクラスを別々に表示します。これは、Eclipseのようなナビゲーターよりもはるかに使い勝手がよくありません。さらに悪いことに、右側のフレームの内側をクリックすると、パッケージインデックスとクラスインデックスがそれに応じて更新されません。あなたは自分がどこにいるのか分かりません。
  • URL。フレームの欠点の1つは、フレームに応じてURLが変更されないことです。個々のフレームのURLを明示的に確認しない限り、JavaDocURLを誰かに送信できないのは非常に苛立たしいことです。
  • ルックアンドフィール。 JavaDocが醜いのを見るのに、デザイナーである必要はありません。 JavaDocをより良くしたいと思っており、それが正しく行われていることを確認したいと思います。あなたが答える質問は、

より良いJavaDocがどうあるべきかを期待しますか?

2
chemhack

これはあなたの質問に直接答えているわけではありませんが、違いを生むことに熱心なので:-)。

OpenJDKの compiler プロジェクトについてJonathon Gibbonsに連絡します。彼は、Javadocシステムのオーバーホールを支援し、あなたが話している種類の機能を提供してくれる人を探しています。これは、変更がJava自体に反映されることを意味します!

または、 OpenJDKを採用 プロジェクトに参加してください。開始します。

5
Martijn Verburg