it-swarm-es.com

¿Por qué el comentario predeterminado de la clase predeterminada de IntelliJ javadoc utiliza una sintaxis no estándar?

¿Por qué el comentario predeterminado de la clase predeterminada de IntelliJ javadoc utiliza 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 para usar, pero ¿por qué no usar la sintaxis de javadoc cuando está disponible?

Para referencia aquí hay un ejemplo:

/**
 * Creado por IntelliJ IDEA. 
 * Usuario: jstauffer 
 * Fecha: 13 de noviembre de 2007 
 * Hora: 11:15:10 AM 
 * Para cambiar esta plantilla, use Archivo | Configuraciones | Plantillas de archivo. 
 * /
44

No estoy seguro de por qué Idea no usa el @author etiqueta por defecto.

Pero puede cambiar este comportamiento yendo a File -> Settings -> File Templates y editando el File Header entrada en la pestaña Includes.

A partir de IDEA 14 es: File -> Settings -> Editor -> File and Code Templates -> Includes -> File Header

53
Rob Dickerson

En AndroidStuido 1.0.2 en Mac

Vaya a Preferencias y luego a la izquierda Plantillas de archivo y código Después de seleccionar las plantillas de archivo y código en el lado derecho, seleccione incluye pestaña seleccione encabezado de archivo y cambie el encabezado de su archivo.

6
user1154390

El valor predeterminado es legible, utilizable, pero no cumple ni sugiere ningún estándar de codificación.

Creo que la razón por la que IntelliJ no usa las etiquetas Javadoc por defecto, 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 debe modificarse para que sea más apropiado.

Donde estoy trabajando, se desaconseja el uso de etiquetas de autor, por varias razones.

4
brasskazoo

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 suposición.

3
Trampas Kirk

Es probable que el fragmento de encabezado que muestre sea anterior a javadoc y se haya tomado prestado de algún documento estándar de codificación, probablemente escrito para C++.

1
Alex B