method - javadoc ejemplo

Detalles de la diferencia entre @see y @inheritDoc

Question

He revisado la referencia de JavaDoc , y si bien entiendo la diferencia básica entre @see (varios enlaces) y {@inheritDoc} (exportación de comentarios de superclase JavaDoc), necesito una aclaración sobre cómo se implementaron las cosas.

En Eclipse IDE, cuando selecciono "Generar comentarios de elementos" para el método heredado (desde la interfaz o la anulación de toString (), etc.) se crea el siguiente comentario

/* (non-Javadoc)
* @see SomeClass#someMethod()
*/

Si se me @see que produzca JavaDoc, lo dejo, reemplace @see con {@inheritDoc} , o {@inheritDoc} genuino como tal:

/**
* {@inheritDoc}
*/

Y cuando hago eso, ¿debo seguir manteniendo el indicador de método de clase #?

Answer 1

En primer lugar, debe eliminar la plantilla de eclipse original porque es solo una chatarra ruidosa. Ponga documentos significativos o no ponga nada en absoluto. Pero el replanteamiento inútil de lo obvio usando plantillas IDE simplemente desordena el código.

Segundo, si se requiere que produzcas javadoc, entonces debes hacer que el comentario comience con /** . De lo contrario, no es javadoc.

Por último, si está anulando, debe usar @inheritDoc (suponiendo que desea agregar a los documentos originales, como @seh señaló en un comentario, si solo desea duplicar los documentos originales, no necesita nada). @see solo debe usarse para hacer referencia a otros métodos relacionados.