2009-04-02 22 views
21

He generado una interfaz que está muy bien documentada. Cada método tiene su propio JavaDoc. Las clases que implementan esta interfaz pueden tener pequeñas diferencias en su lógica.Añadir nueva JavaDoc a existente desde el supermétodo

¿Cómo puedo agregar JavaDoc al JavaDoc existente de la superclase? La palabra clave

/** 
* {@inheritDoc} 
*/ 

solo establece el javaDoc de la superclase en el método actual. Pero cuando intento añadir algunas palabras, el JavaDoc del método súper se ha ido, como

/** 
* {@inheritDoc} 
* These value depends on... 
*/ 

¿Alguien tiene una idea de cómo puedo actualizar el JavaDoc de un método estupendo, sin borrar.

EDIT:

En cuanto a la respuesta Brian Agnew, lo cual es bueno, pero no una respuesta real;)

También puede tener el mismo problema cuando se desea sobrescribir un método existente, como la pintura() en Swing, y desea describir cómo inicializar o manejar el comportamiento del sorteo desde el exterior. Esto no es solo para la descripción de la interfaz.

+6

El problema que ha descrito parece estar solucionado en Java 7. Su código sugerido funciona bastante bien allí. – ubuntudroid

+0

Gran pregunta. Aprendí algo extremadamente útil hoy. Perfecto para documentar las interfaces y luego todos los niños heredan la documentación y le agregan sus propias cosas, por ejemplo, alguna implementación que podría arrojar alguna excepción adicional y, por lo tanto, necesita agregar un único '@ throws' en el Javadoc. – Timmos

Respuesta

12

Supongo que cuando necesitas agregar algo a javadoc, cambiaste algo. Así que tal vez sea correcto escribir javadoc exactamente de la misma manera.

/** 
* Enhanced swing paint for my cool component. 
* @see JButton#paint(); 
*/ 
@Override 
public void paint() { 
    super.paint(); 
    //my stuff 
} 
2

No conozco ningún modismo JavaDoc directo que lo haga. Sin embargo, Eclipse e IntelliJ le permitirán tomar el super JDoc e insertarlo ... está lejos de ser perfecto, como si cambiara el supr JDoc, tendrá que volver a editar todas las anulaciones, pero es mejor que copiar y pegar a mano ...

Cuestiones relacionadas