問題タブ [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 投票する
4 に答える
295290 参照

java - Javadoc で外部 URL にリンクしていますか?

何かのようなもの:

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

jar - コンパイル済みの jar ライブラリから javadoc Web を作成する

クラス ファイルのみを含む jar 形式のサードパーティ ライブラリがあります。

javadoc (またはその他のツール) を実行して、作成できるライブラリ API 呼び出しへの参照を生成できるようにしたいと考えています。

有用なコメントがあまり得られないことはわかっていますが、期待していません。クラスと呼び出しの自動生成された要約が欲しいだけです。

これを行う最善の方法は何ですか?

編集: jad は優れていますが、完璧なコードは生成されません。その結果、javadoc は不平を言います。javadoc にエラーを無視してドキュメントをできる限り生成するように指示する方法はありますか?

0 投票する
5 に答える
3045 参照

javadoc - javadoc コメントのコード例

複数のプログラマーが javadocs の例に貢献しており、一部の例には次のようにフォーマットされたコメントが含まれています。

これらの例を javadoc コメントに入れると、例のコメントを閉じて javadoc コメントを閉じます。

この形式でコメントを書くことができないことを全員に言わずに、これを処理する適切な方法はありますか?

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

javadoc - javadoc @link

Utilクラスに2つのメソッドを記述しました。

メソッドcopy2のJavadocには次のものが含まれます。

テストとして以下も含まれます:

私がhighestOneBitリンクをクリックすると、それは機能します。コピーリンクをクリックすると、正しく機能せず、Utilクラスにリンクしますか?!Javaバージョン1.5.0_16。

0 投票する
5 に答える
3404 参照

eclipse - Eclipse(Java)に相当するGhostDoc

私は Visual Studio でのGhostDocの自動コメント生成の大ファンなので、Eclipse で私の Java コードと同じ仕事をするプラグインを探しています。推奨事項はありますか?

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

java - Eclipse プロジェクト全体の javadoc タグを自動的に作成できますか?

「<alt><shift>J」を使用して、単一のコード要素 (クラス メソッドなど) のタグを作成できることはわかっています。

しかし、プロジェクト全体のすべてのクラスに対してこれらのタグを自動的に作成する方法はありますか? それとも、パッケージまたはクラス レベルだけですか?

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

java - この Javadoc の一部をどのように解釈しますか?

isValid(int)from java.sql.Connection(インターフェース)のドキュメント:

http://java.sun.com/javase/6/docs/api/java/sql/Connection.html#isV​​alid(int)

SQLException「提供された値timeoutが 0 未満の場合」をスローすると述べています。

実装者はこれを「提供された値が 0 未満のSQLException 場合にのみ」と読むべきですか、timeoutそれとも他の多くの理由で自由に投げることができますか?

編集:なぜ彼らがIllegalArgumentException. SQLException「この議論が何であるかについて基本的な誤解をしている」ではなく、「データベースが溶けたように見える」などのことを意味すると思います。

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

java - package-info.java のみの javadoc

クラスのないプロジェクトで javadoc を実行したい状況があります。1 つのパッケージに対して package-info.java しかありません。javadoc を実行すると、次のエラーが表示されます。

package-info.java のみを強制的に処理する方法はありますか?

Maven ビルドの一部として javadoc を実行しているため、maven-javadoc-plugin が実際の javadoc コマンドを実行しています。