¿Es una buena práctica usar el formato automático del texto?

11

Estoy usando Eclipse y lo hablaré como ejemplo, pero estoy seguro de que este es el caso en cualquier otro IDE.

Eclipse tiene el comando CTRL- Shift- Fque formatea automáticamente su código. ¿Es una buena práctica usar este tipo de formato? Pregunto en el contexto de un gran proyecto en el que puede haber muchos programadores trabajando en los mismos archivos y todos estos son administrados por un sistema CSV.

¡Gracias!

Ionut
fuente

Respuestas:

12

Sí lo es.

Eclipse le permite definir su propio estilo de código exportable que puede compartir entre todos sus desarrolladores. Si no desea configurar su propio estilo de formato, puede decirles a sus desarrolladores que usen el formato predeterminado de Eclipse. Incluso si usa el predeterminado, le aconsejaría que lo exportara y lo pusiera en una unidad de red compartida para que todos los desarrolladores lo usen. Si más tarde, decide cambiar una cosa, podrá hacerlo fácilmente.

De todos modos, le aconsejaría que comience lo antes posible, lo mejor sería al comienzo del proyecto y que mantenga su código siempre formateado en el formato elegido. Deberá evitar tener "confirmaciones de formato" puras durante el desarrollo porque es difícil distinguirlas de las confirmaciones "reales". Lo que significa en la práctica es que los desarrolladores deben ser rigurosos con sus compromisos .

Además, y lo pongo al final porque es solo mi opinión personal, pero considere eliminar el límite de 80 caracteres por línea (o extenderlo a algo más grande, tenemos 120 caracteres aquí) que es, si no me equivoco longitud de línea de formato automático predeterminada en Eclipse. Ahora todos tenemos pantallas grandes y resoluciones de pantalla grande, así que está bien. Sobre ese tema, consulte la sección ¿El límite de 80 caracteres sigue siendo relevante en tiempos de preguntas y respuestas de los monitores de pantalla ancha ? Entonces podrá tomar su propia decisión.

Editar: Thorbjørn hace un buen punto sobre la funcionalidad "Formatear cada vez que se guarda un archivo".

Jalayn
fuente
5

Sí, es muy buena práctica. Asegura que todos estén de acuerdo en cómo deberían verse los archivos fuente al abrirlos en un editor.

Además, he tenido muy buenas experiencias con la funcionalidad "Formatear cada vez que se guarda un archivo". (Utilizamos la configuración estándar del formateador Eclipse).

Habilítelo abriendo las propiedades de Eclipse y seleccione Java -> Editor -> Guardar acciones. Habilite "Realizar las acciones seleccionadas al guardar" y "Formatear código fuente".

La razón es, naturalmente, que el código siempre está formateado, por lo que puede formatear a voluntad al editar sin temor a que algo se rompa. Esto también garantiza que los registros del repositorio de origen sean precisos (lo cual es importante cuando se realiza un análisis forense).


fuente
Olvidé eso, buen punto.
Jalayn
3

Debe tener un estándar de codificación que todos sigan. Si esto se aplica mediante herramientas externas (como sangría), o IDE, o manualmente, es algo irrelevante. Lo relevante es que se debe hacer antes de comprometerse.

Sardathrion - contra el abuso SE
fuente
3

Es una buena práctica seguir un estándar de codificación bien definido en un proyecto / empresa. Sin embargo, los medios para hacerlo pueden variar, solo elija lo que funcione mejor para su organización. Si todos usan Eclipse, entonces podría crear un formato de código exportable para sus proyectos y distribuirlo entre los desarrolladores (Eclipse también tiene una opción para formatear archivos automáticamente en cada guardado), sin embargo, recomendaría crear un documento que describa el formato elegido.

devmiles.com
fuente