¿Por qué el comentario por defecto javadoc de la clase predeterminada de IntelliJ usa una sintaxis no estándar?

¿Por qué el comentario javadoc predeterminado de la clase IntelliJ por defecto 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 pero ¿por qué no utilizar la sintaxis de javadoc cuando está disponible?¿Por qué el comentario por defecto javadoc de la clase predeterminada de IntelliJ usa una sintaxis no estándar?

Como referencia aquí es 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. 
*/

Fuente

2008-09-15 James A. N. Stauffer

Soy consciente de que se puede cambiar el valor predeterminado. Me pregunto si hay alguna buena razón por la cual elegiría eso para un incumplimiento. –

No estoy seguro de por qué la idea no utiliza la etiqueta @author por defecto.

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

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

Fuente

2008-09-15 15:25:55

En IDEA 14, esto es Archivo -> Configuración -> Editor -> Plantillas de archivos y códigos -> Incluye -> Encabezado de archivo. –

El valor por defecto es legible, utilizable, pero no se adhiere a ninguna norma o sugiere codificación.

Creo que la razón por la que IntelliJ no utiliza 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.

Fuente

2008-10-03 00:53:54 brasskazoo

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++.

Fuente

2009-05-18 19:12:50

Parece que la compañía fue fundada para hacer un IDE de Java: http://www.jetbrains.com/company/jbstory.html –

Mi punto es que probablemente miraron alrededor y encontraron un documento de estándares de codificación de C++ (tal vez de un trabajo anterior) , tal vez de algún lugar en línea) y tomó el encabezado de eso. –

Porque es una plantilla de archivo predeterminada que se supone que debe cambiar según el estándar de su organización o sus gustos.

Mi mejor intento.

Fuente

2009-05-18 19:42:10

En AndroidStuido 1.0.2 en Mac

Ir en Preferencias luego a la izquierda lapso de archivos y plantillas de códigos de Después de seleccionar las plantillas de archivos de código y en el lado derecho seleccione incluye pestaña seleccionar file Header y cambie su encabezado de archivo.

Fuente

2015-01-11 18:49:05 user1154390

¿Por qué el comentario por defecto javadoc de la clase predeterminada de IntelliJ usa una sintaxis no estándar?

Respuesta

Cuestiones relacionadas