Entiende el código de forma correcta antes de utilizarlo a tu trabajo si tquieres aportar algo puedes dejarlo en los comentarios.
Solución:
Las pautas oficiales sobre esto son bastante claras.
Las diferencias funcionales son:
@link
es un enlace en línea y se puede colocar donde quieras@see
crea su propia sección
En mi opinión, @link
se usa mejor cuando literalmente usa un nombre de clase, campo, constructor o método en su descripción. El usuario podrá hacer clic en el javadoc de lo que ha vinculado.
Yo uso el @see
anotación en 2 casos:
- Algo es muy relevante pero no se menciona en la descripción.
- Me refiero a lo mismo varias veces en la descripción, y se usa como reemplazo de múltiples enlaces a lo mismo.
Basé esta opinión en la comprobación aleatoria de la documentación de una gran variedad de cosas en la biblioteca estándar.
@see
crea una línea aislada en los Javadocs. @link
es para incrustar dentro del texto.
yo suelo @see
cuando es una entidad relacionada pero no me refiero a ella en el texto expositivo. Utilizo enlaces dentro del texto cuando hay un acoplamiento estrecho o (creo) que es probable que el lector se beneficie de la sugerencia de navegación, por ejemplo, deberá hacer referencia a ella directamente.
Hay otra referencia (sección de desaprobación) mismos documentos oficiales para preferir @link
sobre @see
(desde Java 1.2):
Para Javadoc 1.2 y versiones posteriores, el formato estándar es usar la etiqueta @deprecated y la etiqueta @link en línea. Esto crea el enlace en línea, donde lo desee. Por ejemplo:
Para Javadoc 1.1, el formato estándar es crear un par de etiquetas @deprecated y @see. Por ejemplo:
Reseñas y puntuaciones
Nos encantaría que puedieras compartir esta reseña si lograste el éxito.