codestyle; poner javadoc antes o después de la anotación?

Question

Sé que no es el más importante de los problemas, pero me acabo de dar cuenta de que puedo poner el bloque de comentarios javadoc antes o después de la anotación. ¿Qué querríamos adoptar como estándar de codificación?

/** 
* This is a javadoc comment before the annotation 
*/ 
@Component 
public class MyClass { 

    @Autowired 
    /** 
    * This is a javadoc comment after the annotation 
    */ 
    private MyOtherClass other; 
} 

Answer 1

Antes de la anotación, ya que la anotación es un código que "pertenece" a la clase. Ver examples with javadoc en la documentación oficial.

Aquí es ejemplo al azar encontré en another official Java page:

/** 
* Delete multiple items from the list. 
* 
* @deprecated Not for public use. 
* This method is expected to be retained only as a package 
* private method. Replaced by 
* {@link #remove(int)} and {@link #removeAll()} 
*/ 
@Deprecated public synchronized void delItems(int start, int end) { 
    ... 
} 

Answer 2

Todo se reduce a la legibilidad. En mi opinión, el código es más legible con las anotaciones directamente sobre el método/campo.

Answer 3

Acepto las respuestas ya dadas.

anotaciones son parte del código de mientras Javadoc es parte de la documentación (de ahí el nombre) .

Por lo tanto, es razonable mantener juntas las partes del código.

Answer 4

Aparte del estándar de codificación, parece que la herramienta javadoc no procesa los comentarios del documento java si se colocan después de las anotaciones. Funciona bien de lo contrario.