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

documentation - doxygen出力でナビゲーションツリーを生成する方法は?

javadocを使用してからdoxygenに来た場合、クラスからクラスへ、メソッドからメソッドへのジャンプを容易にする階層(フレームベース)ビューが見当たらないと言ったときに、私が何を意味するかを知っているかもしれません。(これを見たことがない人のために、IDEまたはファイルシステム上のツリーナビゲーターを想像してみてください)。

可能であれば、Doxygenにナビゲーションツリーを含めるにはどうすればよいですか?

同様の質問が10月に行われましたが、それはスタイルシートの代替案に関するものであり、1つだけが判明しました。もっとメジャーなものを探していると思います。

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

eclipse - Eclipse で JavaDoc を検索

(Eclipse 経由で) javadoc コメントのみを検索する方法はありますか? javadoc コメント内のテキストを検索したいだけです...

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

java - javadoc フラグメントを照合するための正規表現

この質問は、指定されたテキストを含むjavadocコメントに一致する正規表現で考えさせられました。

たとえば、以下を含むすべてのjavadocフラグメントを検索します@deprecated

私はなんとか式にたどり着きました/\*\*.*?@deprecated.*?\*/が、これは次のような場合に失敗します:

ここで、最初のjavadocフラグメントから 3 番目の javadoc フラグメントまでのすべてのコードに一致します。

誰かがこれに正規表現を与えることができますか?

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

hyperlink - javadoc リンクの書き方

javadoc にリンクを書き込むにはどうすればよいですか?

現在、私は次のようなものを持っています:

Math.sqrtAPI にリンクする必要があるテキストを生成するためにjava.lang.Math.sqrt(double)、ただし、テキストを生成するだけで、リンクは生成しません。

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

java - スーパーメソッドから既存の JavaDoc に新しい JavaDoc を追加します

非常によく文書化されたインターフェースを生成しました。すべてのメソッドには独自の JavaDoc があります。このインターフェイスを実装するクラスは、ロジックにほとんど違いがありません。

スーパークラスから既存のJavaDocにJavaDocを追加するにはどうすればよいですか。キーワード

スーパークラスの javaDoc のみを現在のメソッドに設定します。しかし、いくつかの単語を追加しようとすると、次のようにスーパーメソッドのJavaDocがなくなりました

スーパーメソッドのJavaDocを削除せずに更新する方法を知っている人はいますか?

編集:

ブライアン・アグニューの回答に関しては、これは良いですが、本当の回答ではありません;)

Swing の paint() のような既存のメソッドを上書きしたい場合や、外部から描画動作を初期化または処理する方法を記述したい場合にも、同じ問題が発生する可能性があります。これはインターフェースの説明だけではありません。

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

annotations - javadoc にアノテーションを無視させる

注釈付きインターフェースを文書化し、それがどのように使用されているかのサンプルを javadoc に含めようとしています。例えば

ただし、Javadoc は私の注釈を Javadoc 命令 (@param など) として扱い、その結果、次のようにしか出力されません。

使用例を次に示します。

生成されたドキュメント。これを止めることができた唯一の方法は、注釈の前に余分な文字を追加することです。

しかし、これは少し乱雑に見えます。

誰かに提案があるかどうか疑問に思っただけです、ありがとう。

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

java - ドキュメントが Javadoc に表示されない

私は次の機能を持っています:

私の Javadoc にはそれ (または私が文書化したもの) がありません。これの原因は何ですか?

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

api - Eclipse プラグイン API: 特定のプラットフォーム プラグインに javadoc サポートを追加するにはどうすればよいですか?

Eclipse 3.4 Ganymede を使用していますが、すべてのプラットフォーム プラグイン API、特に JFace e Ui Forms パッケージに javadoc サポートを追加する方法が見つかりません。

「プラグインの依存関係」という名前のライブラリにリンクされている任意の jar のプロパティ パネルを開くと、「Javadoc の場所」ノードに次のメッセージが表示されます。

現在のクラスパス エントリはコンテナ 'Plug-in Dependencies' に属しており、エントリ内の Javadoc の場所をユーザーが変更することはできません"...

有線の javadoc の場所で Eclipse を再構築する必要があるというのはどういう意味ですか?

0 投票する
6 に答える
17896 参照

java - Eclipse : すべてのクラスのメソッドと変数を一覧表示する

他の誰かが書いた Java コードを使い始めています。理解し、変更し、テストする必要があります。著者は現在利用できません。このパッケージには、サイズの異なる約 50 個のファイル (およびクラス) が含まれています。メソッドの名前 (パブリックおよびプライベート) とパブリック変数 (Eclipse の「アウトライン ウィンドウ」に表示されるように) を表示/出力できれば素晴らしいことです。これを見るだけで各クラスの一般的な目的を理解できるので、コードを理解するのに本当に役立ちます。

Javadoc は実際にはあまりにも多くの詳細を作成するので、Javadoc を生成する以外に Eclipse でそれを行うことはできますか? このためのEclipseプラグインはありますか? または他のツールですか?

例:

学生を表す Class ファイルの場合、次のように取得できます。

...