Java - ¿Convención para usar javadoc junto con una anotación de método?

Question

tengo el siguiente método:

@Override 
    public boolean myMethod() 
    { 
     // do stuff 
    } 

Si quiero añadir un javadoc para este método, ¿hay alguna convención sobre cómo hacer esto junto con tener la anotación @ Override (o cualquier otra anotación)?

La razón que pido es porque he leído que los comentarios javadoc deben estar directamente antes del método (no hay saltos de línea entre los dos), y no estoy seguro de si poner el comentario Javadoc directamente por encima de la anotación @ Override ensuciaría cosas claras.

¿Esta sería la forma convencional de hacerlo, por ejemplo? ¿Esto funciona?

/** 
    * This is my method's javadoc comment. 
    */ 
    @Override 
    public boolean myMethod() 
    { 
     // do stuff 
    } 

Answer 1

Sí, de esta manera es la forma correcta, no vi al revés. Y sí, de esta manera funciona. No intenté al revés.

/** 
    * This is my method's javadoc comment. 
    */ 
    @Override 
    public boolean myMethod() 
    { 
     // do stuff 
    } 

Pero básicamente me gustaría por lo general no añadir un comentario Javadoc a un método que anula otro método, especialmente en la aplicación de interfaces. La etiqueta @inheritDoc es útil aquí, para distribuir la documentación sin grandes esfuerzos. Pero eso es específico de este ejemplo, también puede agregar otras anotaciones.

Answer 2

Sí, funcionará correctamente. Por ejemplo, en el source code of java.lang.String de openjdk, están utilizando javadoc en la parte superior de la anotación @Deprecated.