問題タブ [doclet]

For questions regarding programming in ECMAScript (JavaScript/JS) and its various dialects/implementations (excluding ActionScript). Note JavaScript is NOT the same as Java! Please include all relevant tags on your question; e.g., [node.js], [jquery], [json], [reactjs], [angular], [ember.js], [vue.js], [typescript], [svelte], etc.

0 投票する
2 に答える
1023 参照

java - Java: Javadoc を使用して見栄えの良いクラス ドキュメントを作成するにはどうすればよいですか?

以下を含む Java クラス ライブラリの HTML ドキュメントを作成したい

  • プログラミング ガイド情報 - 単なるクラス リファレンスを超えて
  • リファレンス ドキュメントのコード例
  • 折りたたみ可能な領域

スタイル良く見せたい。このようなもの:

代替テキスト

Javadoc は、他の関係者が Javadoc に統合されたドキュメント生成を提供できるようにするドックレット API を公開していると思います。標準の javadoc 出力よりも少し優れた機能を (無料で) 使用できるドックレット オプションはありますか?

これについてグーグルで検索してみましたが、うまくいきませんでした。提案?

補遺doclet.com
を見つけましたが、オプションを評価する方法がわかりません。おすすめは?

特に、XHtmlDocletはこれらの問題に対処したいと考えているようです。使った人いますか? 私はそれを働かせることができません。また、XHTML Doclet 担当者が提供する例は、c.1998 javadoc から生成されたドキュメントよりも見栄えがよくありません。


関連:
Javadoc が非準拠の XHTML を生成するのはなぜですか?

0 投票する
2 に答える
606 参照

java - Java XHTML ドックレット: 致命的な例外

XHTML Docletを使用したことがある人はいますか?それを正常に機能させる方法についてヒントを提供できますか?

私は次のように実行します:

(すべて 1 行で)

実行すると、次のようになります。

うまくいくはずのようです。私は何を間違っていますか?

0 投票する
3 に答える
844 参照

java - Sun Xmlドックレットはまだ利用できますか?

デフォルトのhtmlの代わりにxml形式でjavadocを生成できるドックレットを探しています。いくつか検索したところ、以前はhttp://www.sun.com/xml/developers/doclet/にあったSunXMLドックレットがあることがわかりました。

ただし、このリンクは機能しなくなりました。Sunxmlドックレットのコピーを持っている人はいますか?または他の代替xmlドックレット?

0 投票する
0 に答える
846 参照

eclipse - Eclipse ドックレット プラグイン

標準の組み込みjavadoc 生成プロセスを変更する Eclipse javadoc doclet プラグインを探しています。つまり、カスタム タグを指定し、通常の javadoc コメントで wiki 構文などを使用して、生成された出力をメソッドまたはクラス識別子にカーソルを合わせたときに表示されるポップアップに表示したいと考えています。

明確にするために、外部 javadoc を明示的に生成するときにドックレットを指定する方法を探しているわけではありません。

Eclipse は何らかの内部メカニズムを使用してポップアップ javadoc を生成しているようで、過去 1 時間のグーグル検索では、その動作を変更するプラグインを見つけることができませんでした。

アイデアや指針はありますか?ありがとう!

0 投票する
3 に答える
3348 参照

java - EclipseでDocletをデバッグするにはどうすればよいですか?

Javadocプラグインを使用してMavenビルドで実行するカスタムドックレットを作成していますが、今はEclipseでドックレットをテスト/デバッグしたいと思います。どうやってやるの?

プログラムでjavadocを呼び出す必要がありますか?そしてどうやって?

0 投票する
0 に答える
1261 参照

java - クールな Javadoc ドックレット/テンプレートは何ですか?

私は、デフォルトの Javadoc の見た目があまり好きではありません。見た目はこっちのが好きです。より良い JavaDoc ページを生成するために使用できるその他のテンプレート/ドックレットは何ですか?

0 投票する
1 に答える
60 参照

maven - レポートの作成中または別のフェーズで追加のアーティファクトを生成しますか?

Maven では、1 つの pom から 1 つのアーティファクトしか作成できないことを理解しています。

アーティファクト (my-rest-api) の HTML レポートを作成する javadoc ドックレットを作成しました。このドックレットは、統合テストを作成するためのスタブ リクエストとモデルも作成できます。私の問題は、そこから成果物を作成するために、生成されたクラスを 3 番目の Maven プロジェクト (my-test-models) に手動でコピーする必要があることです。他に方法はありますか?生成されたクラスはソースから作成されるため、my-rest-api アーティファクトだけに依存することはできません。両方のプロジェクト間のパスをハードコーディングできましたが、どちらも好きではありません。何か案は?

0 投票する
1 に答える
484 参照

java - プログラムによって呼び出された Javadoc ドックレットの出力を呼び出し元から取得するにはどうすればよいですか?

既存の Java ソース ファイルから Javadoc をスクレイピングし、カスタム ドックレットを介して前処理するツールを作成しています (処理の詳細は関係ありません)。ドックレットを作成しました。Javaドキュメントに示されているように、プログラム API を介して自分のコードからドックレットを呼び出すことができます。

このメカニズムは、ドックレットの実行結果があったとしても、最初のクラスの Java オブジェクトを介して execute() メソッドの呼び出し元に送信できないという意味で、「書き込み専用」であるように見えます。代わりに、ドックレット内から中間出力をファイルに書き込み、それを呼び出し元から読み戻すなどの面倒な作業に頼る必要があります。

私の質問: たとえば、呼び出し側でカスタム ドックレットによって生成された文字列を直接取得する方法はありますか? 例:

前もって感謝します!

0 投票する
2 に答える
2970 参照

javadoc - javadoc doclet libs : 不正なパッケージ名または実行時の ClassCastException

次の問題に直面しています:

コンソール (Windows 7) で独自の美しいドックレットを実行しようとしています。

これは私を例外の山に導きます:

(常に同じもの)。

次に、StackOverflow で、注釈付きのサードパーティ ライブラリの問題であると誰かが言っているのを見つけました ( StackOverFlow: Why am I gets a ClassCastException when generated javadocs? )。解決策は、注釈付きのライブラリをクラスパスに追加することにあるように見えたので、次の行を実行しました。

そして、私は今次のエラーを受け取っています:

すべてのライブラリが all-libs ディレクトリに含まれています。何が間違っているのか説明してもらえますか?どうもありがとうございました :-)

PS: JDK 1.6 を使用しています

0 投票する
1 に答える
2468 参照

java - Doclets vs DocLava

私の理解は次のとおりです。

  • Java ドックレット API は、以下をルートとする単なる API (インターフェースで構成される) です。com.sun.javadoc
  • Javadoc が実行されると、実行時にバインドする Doclet API impl が検索されます。
  • そのような impl が存在しない場合は、何らかのデフォルトが使用されます (したがって、独自の CSS ファイルなどを指定しなくても Javadoc を生成できます)。
  • Google の DocLava は、そのような Doclet API impl の 1 つです。

これが真である場合、どのようにしてデフォルトよりも異なる Doclet impl (DocLava など) を指定するのでしょうか? 私がベースから外れているとすれば、Javadoc ツール、Doclet API、および DocLava はすべて互いにどのように関連しているのでしょうか?