83

それに直面しましょう:デフォルトのJavadocが見苦しいことを確認するために、設計者である必要はありません。

Web上には、スタイルを変更したJavadocを提供するリソースがいくつかあります。ただし、デフォルトの動作は製品を表しており、適度に見栄えがよいはずです。

もう1つの問題は、Javadocの使いやすさが他の同様のリソースと比較して最新ではないという事実です。

特に巨大なプロジェクトは、Firefoxのクイック検索を使用してナビゲートするのは困難です。

実用的な質問:
ブラウザよりも使いやすい方法で既存のJavadocを参照できるスタンドアロン(デスクトップ)アプリケーションはありますか?
私はMonoのドキュメントブラウザのようなものを考えています。

理論的な質問:
Javadocを何らかの形で標準化された方法で進化させる計画があるかどうか、誰か知っていますか?
編集: このトピックに関するSunのwikiへの便利なリンク

4

12 に答える 12

42

Markdown 形式のテキストでソース コメントを受け取り、同じ HTML Javadoc を作成するMarkdown (Java) Docletを作成しました。

新しいドックレットはテキストのスタイル変更も行いますが、生成された HTML はこの段階では変更されません。

これは、おそらく現在の Javadoc の最大のユーザビリティ問題である HTML-in-java-commenting の問題に対処するのに役立ちます。

于 2009-06-25T12:50:19.540 に答える
21

Javadoc の概念が時代遅れだとは思いません。私が見る限り、これらの概念は何年も前に doxygen という名前の製品に根ざしており、他の言語 (つまり、頻繁に使用される Objective-C) でまだ利用できます。これにも前任者がいます。ドナルド・クヌースが TeX ( Literate programming )を作成するために使用したプログラミング環境を見てください。

それでも、プログラム コードとドキュメントのソースを 1 つにまとめることは興味深い考えです。

それに加えて、JavaDoc ツールでサポートされているプラ​​グイン システムを使用して、ドキュメントの表示を特別なニーズに合わせてカスタマイズできます。Web 経由で直接アクセスできるデータベースに直接パブリッシュするプラグイン (私たちのように) を提供することもできます。コラボレーションを使用すると、誰でもドキュメントに追加のコメントや説明を提供でき、元のソースに戻る可能性があります。

于 2009-06-22T11:07:37.097 に答える
13

Javadoc は、私が今まで見た中で最高のソース コード自動ドキュメント生成システムです。その大部分は、とてもシンプルだということです。必要に応じて、5 年前の携帯電話でも Javadoc をブラウズできます。多少の改良が必要であり、特に JDK を参照するのは面倒であることに同意しますが、現在私たちが持っているのは RESTful で使いやすいソリューションであり、その目的のために機能するため、車輪を完全に再発明することは敢えてしません。ほぼどこでも。

于 2009-06-22T11:32:11.557 に答える
5

個人的には、Javadoc は今でも非常に便利だと思います。特に標準化されているためです。ナビゲートしやすい主要なドキュメント スタイルを知りません (これは主観的なものかもしれませんが、たとえば、MSDN は個人的には使いにくいと思います)。

検索の場合: Javadoc Search Frameを使用すると、あらゆる種類の Javadoc をより簡単に使用できるようになります。Firefox の UserscriptおよびGoogle Chrome Extensionとして利用できます。

于 2009-06-22T11:19:29.680 に答える
4

あなたの実用的な質問に答えるために、私はググって友達に尋ねて、これらを思いついた. Forrestdoc、ドックレット、doxygen。

2 番目の質問です。「Web-oh-twoeye」ではありませんが、少なくともオフライン環境で動作することが保証されており、API と一緒に出荷するのに十分小さいです。私はフレームの使用を軽視しますが、Javadoc ではかなりうまく機能します。変更する予定は見たことがありません。Eclipse は、javadoc の読み取り、解釈、および生成に関する限り、javadoc をある程度サポートしています。

于 2009-06-22T11:11:40.863 に答える
3

より攻撃的で威圧的な方法でそれを表現したいかもしれません. ほとんどの人は、技術リソースがどのように見えるかを気にせず、「Web 2.0 だけでは十分ではありません!」気まぐれなマーケットロイドのように聞こえます。

そして、「より使いやすい」とは正確には何だと思いますか?個人的には、全文検索とより優れた使用法を備えたブラウザーが絶対に必要であり、AJAX はそれらの助けになる可能性があります。

JavaDoc の良いところは、時代遅れとは正反対で、任意に拡張できることです。先に進んで、必要な種類の API ドキュメントを生成するドックレットを作成してみませんか?

なぜ今まで誰もそれをしなかったのか (これは明らかにそうです) は、誰の推測でもあります - おそらく、あなたほどそれについて強く感じている人はいないでしょう.

于 2009-06-22T11:12:09.413 に答える
2

DocBook ドックレットがあります。DocBook は (X)HTML よりもリッチなドキュメント タイプであり、技術的な内容を記述するのに適しています。DocBook ソースから、あらゆる種類の異なる出力形式を生成できます。

于 2009-06-22T11:03:12.787 に答える
2

何らかの形で標準化された方法でJavadocを進化させる計画があるかどうか、誰かが知っていますか?

Javadoc の機能強化を指定する対応する JSR (JSR 260) は、JDK 7 から除外されました (現時点では)。計画されたものの概要 (このサイトから):

Javadoc をアップグレードしてより豊富なタグ セットを提供し、Javadoc ドキュメントのより構造化されたプレゼンテーションを可能にします。この JSR は、メソッドとフィールドの分類、クラスとパッケージのセマンティック インデックス、静的、ファクトリ、非推奨のメソッドと通常のメソッドの区別、プロパティ アクセサーの区別、ビューへの情報の結合と分割、例と一般的なユース ケースの埋め込み、もっと。

JDK 7 の全体的な見通しはかなり厳しいものです。

于 2009-06-23T09:52:50.063 に答える
2

個人的には、HTML (したがってタグを使いやすい) JavaDoc よりも読みやすい「コメント ドキュメント」標準が必要です。

たとえば、ここで使用されている MarkDown は、優れたものであり、ソース内で人間が判読でき、ソースの外部で適切にフォーマットされています。

現在の JavaDoc では、多くの人が JavaDoc コメントを使用していると思いますが、実際にはできる限り文書化していません。文書化されていない、またはほとんど文書化されていない API のオンライン JavaDoc を閲覧したことがある人は多いと思います。

これは、JavaDoc コメント (項目のリストなど) 内に配置した可能性のある読み取り可能な構造を 1 つの大きなテキストの塊に完全に破棄するコード再フォーマッター (Eclipse 内、またはソースのコミット時など) では役に立ちません。 1 つを使用したい場所で文字通り 2 つのキャリッジ リターンを使用しない限り)。

于 2009-06-23T09:19:24.093 に答える
1

JavaDoc自体は非常に柔軟性があります。これは、標準のドックレットをカスタムのドックレットに置き換えて、プロジェクト固有のニーズを満たすものを提供できるためです。

私が取り組んでいるプロジェクトでは、JavaDocが完全に統合された製品用にHTML / XMLベースのドキュメントシステム(JSでクライアント側のXSLT 2.0を使用)を作成しました。このために、カスタムドックレットを使用してXMLでJavaDocデータを生成し、これはtagsoupを使用して、コードコメント内のHTMLマークアップでさえも整形式であることを確認しました。

これにより、単一ページのアプリ(デスクトップツールと同様)を使用してインタラクティブなユーザーエクスペリエンスを提供できましたが、サーバー側のコードやインフラストラクチャを使用せずに、すべてブラウザー内から実行できました。ビューアには、検索、ツリーナビゲーションなどの標準機能が含まれていました。

かなり膨大なドキュメントのサンプルエントリポイントへのリンクは次のとおりです 。JavaDocビューアのサンプル

これも画像です: ここに画像の説明を入力してください

于 2012-09-29T07:05:58.650 に答える
0

スマートな検索可能な javadoc ビューア:

私は、JavaDoc をブラウズする際に何度も問題に直面しました。Adnroid doc 検索オプションのようなものを探していました。ついに私はそのようなものを手に入れます。Firefox を使用している場合の解決策はこちらです。

  1. プラグイン GreaseMonkey をインストールします。これは、私たちが見ているように Web ページをカスタマイズするものです。(クラス名で検索できるように、Java doc ページをカスタマイズする必要があります) https://addons.mozilla.org/en-US/firefox/addon/greasemonkey/

  2. グリースモンキーが機能するには、カスタマイズ用のユーザー スクリプトが必要です。これは、greasemonkey によって自動的にダウンロードされます。JavaDoc 検索フレームまたはJavaDoc インクリメンタル検索からユーザースクリプトをインストールします。

これは私にとってとてもうまくいきます。

于 2011-02-27T13:24:45.900 に答える