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

javadoc tags

Question

Esta pregunta ya tiene una respuesta aquí:

• codestilo ¿Poner javadoc antes o después de la anotación? 4 respuestas

Tengo el siguiente método:

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

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

La razón por la que pregunto es porque he leído que los comentarios de javadoc DEBEN estar directamente antes del método (no hay nuevas líneas entre los dos), y no estoy seguro de que poner el comentario de javadoc directamente encima de la anotación @Override pueda arruinar las cosas.

¿Sería esta 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í, esta es la forma correcta, no vi todavía al revés. Y sí, así funciona. No probé al revés.

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

Pero, básicamente, normalmente no agregaría un comentario javadoc a un método que reemplaza a otro método, especialmente al implementar 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 código fuente de java.lang.String de openjdk, están usando javadoc encima de la anotación @Deprecated .