2012-01-14 6 views
0

メソッドのための単純なjavadocの生成方法は知っていますが、私のメソッドが呼び出すメソッドへのリンクを自動的にインクルードすると非常に便利だと思いました。メソッドコードをスキャンし、javadocに呼び出されたメソッドへの参照を自動的に配置するツールはありますか?簡単な例:呼び出されたメソッドへの参照を自動的に生成するjavadocを生成するツールはありますか?

B、C、Dを呼び出すメソッドAを使用すると、B、C、Dを呼び出すことを示すAのjavadocにjavadocを追加すると便利ですこれらのメソッドを使用すると、javadocを読むことができます)。

私が本当に探しているのは、私が通常行っているように私のコードを文書化し、このツールを実行してから、私は何を教えてくれるのでしょうか?メソッド、およびそれが呼び出す他のすべてのメソッド(好ましくは、メソッドが呼び出される順序で)が含まれます。

確かにそのようなツールは、(それらのおそらく複数のもの)が存在し、私は賭け1が最高であるに意見がたくさんあります。

答えて

0

使用 "Doxygenの"。

あなたも、@seeタグのない機能の関係を得ることができます。

あなたが「function_call」スイッチをオンにしていることを確認してください、confファイルを編集することを忘れないでください。(申し訳ありませんが、私はスイッチの名前についてはかなりわからない)私はタスクベースのフレームワーク、各タスクで働いています

0

私はそのようなツールが存在するとは思いません。私はそれがしないことを望む。ドキュメンテーションのポイントは、物事をより明確にすることです。@seeが各メソッド呼び出しに追加されれば、スパゲッティの束になるでしょう。 (おいしいですが、並べ替えたいものは何もありません)@seeを関連性のある方法または関連する方法に制限する必要があります。

もちろん、javadocにコードを追加することができます。かもしれないは、Javadocにリンクするためのソースコードメソッド呼び出しを取得する方法です。もちろん、Open Declaration(F3)オプションを使用してEclipseのメソッド宣言にジャンプすることもできます。

+0

クラスは非常に小さく、比較的少数の他のタスクを呼び出します。この場合、どのタスクが他のタスクと呼んでいるかを知ることは非常に役に立ちます。しかし、一般的には、私はあなたに同意します。 – user1148956

関連する問題