Javadoc{@inheritDoc} clase de etiqueta

Question

Me gustaría usar la clase {@inheritDoc} para heredar métodos de mi clase abstracta. En la documentación de la clase abstracta, me refiero a la clase abstracta por su nombre. ¿Cómo puedo etiquetar esto para que cuando la subclase hereda la documentación de la súper clase, reemplace el nombre de la clase abstracta con el nombre de la subclase?

Answer 1

Lo que está describiendo no es compatible con la herramienta de generación javadoc.

Y creo que hay una buena razón para esto también:

Si su método en la subclase es simplemente una implementación de un método abstracto, entonces creo que sería correcto dejar el nombre de la clase abstracta allí.

Por otro lado, si su método en la subclase no es solo una implementación simple y hace algo más que es digno de mención (lo suficiente como para ser mencionado en el javadoc), entonces debe escribir un nuevo javadoc sobre el método en la subclase. de invocar inheritDoc.

Answer 2

No tengo conocimiento de una forma, pero podría explicar por qué quiere hacer {@inheritDoc} . Puedo malinterpretarlo, pero parece confuso. Puede documentar cómo varía su implementación concreta de la matriz y usar @see para referirse al contrato en la clase abstracta. Nota: " Copia automática de los comentarios del método " puede obviar la necesidad de un {@inheritDoc} explícito.

Answer 3

También puede, IIRC, escribir texto adicional alrededor de la etiqueta {@inheritDoc} en sus propios comentarios.