問題タブ [javadoc]

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 投票する
1 に答える
2265 参照

java - カスタム docletpath に複数のパスを含めるにはどうすればよいですか?

ドックレットのクラスパスに追加の jar ファイルを必要とする Javadoc ドックレットがあります。コマンドラインからドックレットを実行するには、次のようにします。

それを実行すると、パス上のドックレットが検出されて実行されますが、ドックレットはクラスパスに必要な追加の jar を使用するため、最終的に ClassNotFoundException が発生します。

コマンドラインを次のように変更すると:

ドックレット ( ) が見つからなくなりましたjavadoc: error - Cannot find doclet class com.adventact.si.workflow.javadoc.ListClass。したがって、doclet 引数はパスのリストを受け入れず、単一のパスのみを受け入れるようです。

(これらのコマンド ラインは完全ではないことに注意してください。クラスパスの設定方法は示していません。これは、docletpath の問題とは関係がなく、本当にスパム的であるためです。)

これをどのように回避しますか?

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

eclipse - Eclipse: JavaDoc を複数の JAR ファイルに添付するにはどうすればよいですか?

私はEclipse 3.4.1を使用しています。

一連の JAR ファイルといくつかの HTML JavaDoc で構成される外部ライブラリがあります。HTML JavaDoc を個々の JAR に添付するには、[プロパティ] ページの JavaDoc の場所に移動し、そこで設定することを知っています。

しかし、個々の JAR ごとにこれを行うのは面倒です。どういうわけかそれらを一度に行うことは可能ですか?JavaDoc の場所はすべて同じです。

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

eclipse - Eclipse: 1 つの JAR に複数の JavaDoc の場所を添付できますか?

私はEclipse 3.4.1を使用しています。

これは奇妙に聞こえるかもしれませんが、Eclipse プロジェクトの同じ JAR に複数の JavaDoc の場所をアタッチできるようにしたいと考えています。この特定の JAR には、2 セットの JavaDoc からのクラスがあります。これは、サードパーティの JAR と、OSGi で動作させるためにその JAR の上にあるその他のサードパーティのコードで構成される OSGi バンドルであるためです。

両方のパッケージのソース コードがあり、そのソース コードが Eclipse プロジェクトにある場合、問題なく動作します。しかし、JAR と JavaDoc しか持っていない場合でも、これを機能させたいと考えています。

0 投票する
18 に答える
236198 参照

java - Javadoc コメント内の複数行のコード例

メソッドの Javadoc コメントに含めたい小さなコード例があります。

問題は、コード例が改行なしで Javadoc に表示され、読みにくいことです。

コードタグが改行を処理すると仮定するのは間違っていると思います。Javadoc コメントでコード例をフォーマットする最良の方法は何ですか?

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

java - Javadoc と Ant を使用したドキュメント カバレッジの測定

私は、パブリック API ドキュメントが明確な成果物であるプロジェクトに携わっています。リリースがこの要件を確実に満たすようにするために、ドキュメント カバレッジが低すぎる場合、Ant ビルド ファイルのリリース ターゲットが失敗するようにしたいと考えています。

少なくとも、公開アクセスまたは保護アクセスを持つ各識別子には、適切な Javadoc タグと説明が必要です。たとえば、パブリック メソッドには、@param各パラメーターの@returnタグ、戻り値の型が でないvoid場合の@throwsタグ、各例外のタグ、および 1 行の説明が必要です。

私は現在、Cobertura を使用した JUnit コード カバレッジ レポートと障害状況を持っているので、ドキュメントと同様のものが最適です。ただし、障害状態の検出が利用できない場合は、レポートが妥当な代替手段となります。

ドキュメントは Javadoc 形式である必要があります。Doxygen を含む他の形式は受け入れられません。

0 投票する
7 に答える
11832 参照

java - Eclipse で SWT と JFace の JavaDoc を取得するには?

私は Eclipse の初心者で、編集中に SWT と JFace の JavaDocs を表示する方法がわかりません。

どうすればいいですか?ありがとう!

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

java - ある ByteBuffer から別の ByteBuffer にバイトを転送する

bbuf_srcByteBufferから別の ByteBuffer にできるだけ多くのバイトを配置する最も効率的な方法は何ですかbbuf_dest(転送されたバイト数を知ることもできます)? 試しbbuf_dest.put(bbuf_src)ていますが、BufferOverflowException をスローしたいようで、必要なときに Sun から Javadoc を取得できません (ネットワークの問題)。>:( ああ。


編集: darnit、@Richard のアプローチ (バッキング配列から put() を使用)bbuf_srcは、bbuf_src が ReadOnly バッファーの場合、その配列にアクセスできないため機能しません。その場合、どうすればよいでしょうか???

0 投票する
4 に答える
1154 参照

java - Sun javadocs / ミラー Web サイトのダウンロード

当社と Sun の javadoc 間のネットワークがダウンしているようです。特定のパッケージの javadoc のコピーはどこで入手できますか?これにより、将来のネットワーク障害に対処するために自分の隠し場所を保持できますか? Sun javadocs のミラーはありますか?

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

documentation - 改行を
タグに変換する方法(wysiwyg)

暗黙の改行が出力Javadocに反映されていること、つまり改行が<br/>タグに変換されていることを確認するにはどうすればよいですか?<br/>コメントの各行にタグを追加することを忘れないようにするのは非常に面倒です。もちろん、タグがない<br/>と、コメント全体が読み取り不可能なブロックに凝縮されます。

たぶん、改行を<br/>タグに置き換えるだけのドックレットですか?私はかなりグーグルで検索しましたが、何も思いつきませんでした。自分のドックレットを書き始める前に、何かを見逃していないことを確認したかったのです。