Bienvenido a nuestro sitio web, aquí vas a encontrar la resolución a lo que buscabas.
Solución:
De la recomendación de Oracle Cómo escribir comentarios de documentos para la herramienta Javadoc:
@return (página de referencia)
Omita @return para los métodos que devuelven void y para constructores; incluirlo para todos los demás métodos, incluso si su contenido es completamente redundante con la descripción del método. Tener una etiqueta @return explícita hace que sea más fácil para alguien encontrar el valor devuelto rápidamente. Siempre que sea posible, proporcione valores devueltos para casos especiales (como especificar el valor devuelto cuando se proporciona un argumento fuera de los límites).
Si a usted (como a mí) realmente no le gusta violar DRY, entonces esta es una de las líneas más importantes de la referencia de javadoc:
Es posible tener un comentario con solo una sección de etiqueta y sin descripción principal.
(@ver http://docs.oracle.com/javase/7/docs/technotes/tools/solaris/javadoc.html#tagsection)
Por lo tanto, es perfectamente válido (y funciona) para métodos simples para escribir su javadoc como:
/**
* @return the name of the object
*/
public String getName();
Así que incluso podrías escribir algo como esto:
/**
* @return the n-th element of the object
*
* @param n index of element to get
*/
public String get( int n );
Que es (después de conocerse un poco) más legible en la fuente y mejor mantenible como la forma más larga que viola DRY.
Con javadoc 16 puedes hacer uso del nuevo combo @return ... etiqueta en orden “para evitar la duplicación de información de devolución en situaciones simples”.
/**
* @return the name of the object
*/
public String getName();
Es equivalente al estilo (todavía soportado):
/**
* Returns the name of the object.
*
* @return the name of the object
*/
public String getName();
Encuentre más detalles en https://bugs.openjdk.java.net/browse/JDK-8075778
Si crees que ha resultado de ayuda nuestro post, sería de mucha ayuda si lo compartes con otros programadores así contrubuyes a difundir este contenido.