202

誰かがjavadoc@seeとの違いを教えてもらえ{@link}ますか？

というか、いつ使うのか？

4

4 に答える 4

232

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

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

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

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

私@seeは2つの場合に注釈を使用します：

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

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

于 2012-04-10T22:15:14.040 に答える
50

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

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

于 2012-04-10T22:42:05.293 に答える
6

タグは@seeタグとは少し異なり、いくつかの点@linkで
制限されており、他の点ではより柔軟です。

さまざまなJavaDocリンクタイプ さまざまなJavaDocリンクタイプ

  1. より良い学習のためにメンバー名を表示し、リファクタリング可能です。リファクタリングで名前を変更すると、名前が更新されます
  2. リファクタリング可能でカスタマイズ可能。メンバー名の代わりにテキストが表示されます
  3. 名前を表示し、リファクタリング可能
  4. リファクタリング可能、カスタマイズ可能
  5. かなり平凡な組み合わせです：
  • リファクタリング可能でカスタマイズ可能で、「関連項目」セクションにとどまります
  • Eclipseホバーでうまく表示されます
  • 生成時にリンクタグとそのフォーマットを表示します
  • 複数の@see項目を使用する場合、説明のコンマは出力を混乱させます
  1. 完全に違法; ジェネレータで予期しないコンテンツと不正な文字エラーが発生します

以下の結果を参照してください。

さまざまなリンクタイプでのJavaDoc生成結果 さまざまなリンクタイプでのJavaDoc生成結果

よろしくお願いします。

于 2020-12-30T18:40:13.603 に答える
5

（Java 1.2以降）優先する別のリファレンス（非推奨セクション）と同じ公式ドキュメント{@link}があります：@see

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

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

于 2018-09-27T06:57:43.313 に答える