Javadoc @seeまたは{@link}?


回答:


213

これに関する公式のガイドラインはかなり明確です。

機能の違いは次のとおりです。

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

私の意見で{@link}は、説明でクラス、フィールド、コンストラクター、またはメソッド名を文字どおりに使用する場合に最適です。ユーザーはクリックして、リンクしたもののjavadocにアクセスできます。

@seeは2つのケースで注釈を使用します。

  • 何かが非常に関連していますが、説明には記載されていません。
  • 説明の中で同じものを何度も言及し、同じものへの複数のリンクの代わりとして使用されます。

この意見は、標準ライブラリのさまざまなドキュメントをランダムにチェックアウトすることに基づいています。


3
javadocは、@ linkはかなり集中的であり、必要な場合にのみ使用する必要があることを警告しています。
トーマス

4
お探しの方は@linkOracleのJavadocガイドで詳細(上記のコメントの警告を含む)を入手できます。
Ash Ryan Arnwine

48

@seeJavadocsに孤立した行を作成します。{@link}テキスト内に埋め込むためのものです。

@see関連エンティティの場合に使用しますが、説明文では言及していません。テキスト内でリンクを使用しているのは、結合が密である場合、または(私が思うに)読者がナビゲーションのヒントから恩恵を受ける可能性が高い、たとえば、直接参照する必要がある場合です。


3

別の参照(非推奨セクション)同じあります公式ドキュメント好む{@link}以上@see(Javaの1.2以降)は:

Javadoc 1.2以降の場合、標準形式は@deprecatedタグとインライン{@link}タグを使用することです。これにより、必要な場所にインラインでリンクが作成されます。例えば:

Javadoc 1.1の場合、標準形式は@deprecatedタグと@seeタグのペアを作成することです。例えば:

弊社のサイトを使用することにより、あなたは弊社のクッキーポリシーおよびプライバシーポリシーを読み、理解したものとみなされます。
Licensed under cc by-sa 3.0 with attribution required.