誰かがjavadoc @see
と{@link}
の違いを教えてもらえますか?
むしろ、いつそれらを使用するのですか?
これに関する 公式ガイドライン はかなり明確です。
機能の違いは次のとおりです。
{@link}
はインラインリンクであり、好きな場所に配置できます@see
は独自のセクションを作成します私の意見では、{@link}
は、説明で文字通りクラス、フィールド、コンストラクター、またはメソッド名を使用する場合に最適です。ユーザーは、リンクしたもののjavadocをクリックすることができます。
2つの場合に@see
注釈を使用します。
この意見は、標準ライブラリ内の多種多様なドキュメントをランダムにチェックアウトすることに基づいています。
@see
は、Javadocsに独立した行を作成します。 {@link}
は、テキスト内に埋め込むためのものです。
関連するエンティティである場合、@see
を使用しますが、説明テキストでは参照しません。密結合がある場合はテキスト内のリンクを使用します。または、読者がナビゲーションヒントの恩恵を受ける可能性が高いと思われます。たとえば、直接参照する必要があります。
{@link}
よりも@see
(Java 1.2以降)を優先する別の参照(非推奨セクション)= 公式ドキュメント があります。
Javadoc 1.2以降の場合、標準形式は@deprecatedタグとインライン{@link}タグを使用することです。これにより、必要な場所にインラインでリンクが作成されます。例えば:
Javadoc 1.1の場合、標準形式は@deprecatedタグと@seeタグのペアを作成することです。例えば: