usar - javadoc pdf

estilo de código; poner javadoc antes o después de la anotación?

Question

Sé que no es el más vital de los problemas, pero me di cuenta de que puedo poner el bloque de comentarios javadoc antes o después de la anotación. ¿Qué querríamos adoptar como un 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. Vea ejemplos con javadoc en la documentación oficial.

Aquí hay un ejemplo al azar que encontré en otra página oficial de Java :

/**
 * 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

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.

Answer 3

Estoy de acuerdo con las respuestas ya dadas.

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

Entonces, para mí, es razonable mantener juntas las partes del código.

Answer 4

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