it-swarm.com.de

Javadoc @see oder {@link}?

Könnte mir jemand den Unterschied zwischen Javadoc @see und {@link} erklären? 

Oder besser, wann welche von ihnen verwenden?

155
membersound

Die offiziellen Richtlinien dazu sind ziemlich klar.

Die funktionalen Unterschiede sind:

  • {@link} ist ein Inline-Link und kann an beliebiger Stelle platziert werden
  • @see erstellt einen eigenen Abschnitt

Meiner Meinung nach wird {@link} am besten verwendet, wenn Sie in Ihrer Beschreibung buchstäblich einen Klassen-, Feld-, Konstruktor- oder Methodennamen verwenden. Der Benutzer kann in den Javadoc des verknüpften Links klicken.

Ich benutze die Annotation @see in 2 Fällen:

  • Etwas ist sehr relevant, wird aber in der Beschreibung nicht erwähnt.
  • Ich verweise in der Beschreibung mehrfach auf dasselbe und wird als Ersatz für mehrere Links zu demselben verwendet.

Dieses Gutachten stützte sich auf das zufällige Durchsuchen der Dokumentation für eine Vielzahl von Dingen in der Standardbibliothek.

190
MarioDS

@see erstellt eine isolierte Zeile in den Javadocs. {@link} dient zum Einbetten in Text.

Ich verwende @see, wenn es sich um eine verwandte Entität handelt, ich beziehe mich jedoch nicht auf diesen Text im Expository. Ich verwende Links innerhalb von Text, wenn eine enge Verknüpfung besteht, oder (ich glaube), der Leser würde wahrscheinlich von dem Navigationshinweis profitieren, z.

41
Dave Newton

Es gibt eine andere Referenz (veraltet Abschnitt) gleichen offizielle Dokumente um {@link} über @see (seit Java 1.2) zu bevorzugen:

Für Javadoc 1.2 und höher wird standardmäßig @deprecated .__ verwendet. Tag und das Inline-Tag {@link}. Dadurch wird der Link inline erstellt, wobei du willst es. Zum Beispiel:

Für Javadoc 1.1 wird standardmäßig ein Paar von @deprecated- und @see-Tags erstellt. Zum Beispiel:

0
user7294900