intellij idea - generate - ¿Por qué el comentario por defecto javadoc de la clase predeterminada de IntelliJ usa una sintaxis no estándar?
javadoc example (5)
El valor predeterminado es legible, utilizable, pero no se adhiere o sugiere ningún estándar de codificación.
Creo que la razón por la que IntelliJ no usa las etiquetas Javadoc en forma predeterminada es para evitar posibles interferencias con cualquier estándar de codificación / javadoc que pueda existir en las tiendas de desarrollo. Debería ser obvio para el usuario si el valor predeterminado necesita ser modificado para algo más apropiado.
Donde estoy trabajando, se desaconseja el uso de etiquetas de autor, por varias razones.
¿Por qué el comentario por defecto javadoc de la clase predeterminada de IntelliJ usa una sintaxis no estándar? En lugar de crear una línea con "Usuario: jstauffer", podría crear una línea con "@author jstauffer". Las otras líneas que crea (Fecha y Hora) probablemente no tienen la sintaxis de javadoc pero ¿por qué no utilizar la sintaxis de javadoc cuando está disponible?
Para referencia aquí hay un ejemplo:
/** * Created by IntelliJ IDEA. * User: jstauffer * Date: Nov 13, 2007 * Time: 11:15:10 AM * To change this template use File | Settings | File Templates. */
En AndroidStuido 1.0.2 en Mac
Vaya en Preferencias y luego en lapso izquierdo . Plantillas de archivos y códigos Después de seleccionar las plantillas de archivos y códigos en el lado derecho, seleccione incluye la pestaña seleccionar el encabezado del archivo y cambie el encabezado de su archivo.
Es probable que el fragmento de encabezado que muestre sea anterior a javadoc y que haya sido tomado prestado de algún documento estándar de codificación, probablemente escrito para C ++.
Porque es una plantilla de archivo predeterminada que se supone que debes cambiar según el estándar de tu organización o tus gustos.
Mi mejor conjetura.
No estoy seguro de por qué Idea no usa la etiqueta @author por defecto.
Pero puede cambiar este comportamiento yendo a File -> Settings -> File Templates y editando la entrada del File Header en la pestaña Includes .
A partir de IDEA 14 es: File -> Settings -> Editor -> File and Code Templates -> Includes -> File Header