[解決済み] JavaDocの@seeの使い方？

質問

どのような場合に @see JavaDocsを扱うとき？その使い方は？

例えば MethodA コール MethodB を追加する必要がありますか？ @see で MethodB の javadoc を参照し MethodA というのは、それが呼び出したものだからです。 MethodB から MethodA を呼び出しているからです。に関するものを読みました。 @see オラクルのウェブサイトを見ると、信じられないほど曖昧で、「"see also"」と書いてありますが、実際にはどういう意味なのかわかりません。

どのように解決するのですか？

そうですね、かなり漠然としていますね。

あなたのメソッドのドキュメントを読む人にとって、他のメソッドも見ておくと便利だと思われるときに、これを使うべきです。もし、あなたのメソッドAのドキュメントに "Works like methodB but ..." と書かれていたら、確かにリンクを貼るべきでしょう。 代替案として @see は、インラインの {@link ...} タグを使用します。

/**
 * ...
 * Works like {@link #methodB}, but ...
 */

メソッドAがメソッドBを呼び出すことは実装の詳細であり、外から見て本当の関係はない場合、ここにリンクは必要ないでしょう。