[解決済み】Javadocの@seeと{@link}のどちらを選ぶ？｝

質問

誰かjavadocの違いを教えてください。 @see と {@link} ?

というか、どのタイミングでどれを使えばいいのか？

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

その 公式ガイドライン これについては、かなり明確です。

機能的な違いは。

• {@link} はインラインリンクで、好きな場所に配置することができます。
• @see 独自のセクションを作成します。

私見ですが {@link} は、クラス名、フィールド名、コンストラクタ名、メソッド名を文字通り記述する場合に使用するとよいでしょう。ユーザーは、あなたがリンクしたもののjavadocをクリックすることができます。

私が使っているのは @see アノテーションは2つのケースで使用されます。

• 非常に関連性が高いが、説明文に記載されていないものがある。
• 説明文の中で同じものを複数回参照し、複数のリンクの代わりとして使用している。

この意見は、標準ライブラリの非常に様々なもののドキュメントをランダムにチェックしたことに基づいています。