Pausa para el café #86. Una guía rápida y sencilla para reformatear el código en IntelliJ IDEA

Fuente: Lightrun Como desarrollador, deberá realizar cambios en el código base. Y si la base del código no está claramente formateada, la depuración le resultará mucho más difícil. Los pequeños cambios como el cambio de formato y la sangría adecuada en el código generalmente se pasan por alto, pero obviamente ayudan a diferenciar el código base de un desarrollador profesional del código base de un principiante. Mantener el formato y la sangría del código adecuados le ayudará a escribir código que sea más fácil de leer. Esto simplifica la colaboración en proyectos, aumenta la velocidad de depuración y mantiene la base del código. El código se vuelve más legible y estructurado. ¿Es posible acelerar el proceso de reformateo del código? Este artículo le presentará un método sencillo para reformatear código automáticamente utilizando IntelliJ IDEA. Aprenderá cómo reducir el tiempo requerido para este procedimiento y también aprenderá cómo excluir partes del código base del formateo usando varios atajos de teclado.

Beneficios de reformatear

Es importante recordar que no se requiere formato ni código de comentarios para que la función funcione. El compilador puede leer y ejecutar completamente cualquier código, con o sin formato. Por otro lado, reformatear hace que el marcado sea mucho más fácil de leer para las personas. Para el compilador, lo único que importa es que el código funcione y que no contenga errores, y no qué tan bueno sea o qué tan bien sangrado esté. Es cierto que esto último es lo que preocupa a la gente, porque tienen que leer ese código. Al igual que con el texto sin formato, a nadie le gusta leer contenido informe sin títulos, párrafos ni sangrías. Algunas de las técnicas de reformateo necesarias incluyen:

• Sangrar.
• Funciones de estilo y escritura.
• Espacio vacio.
• Uso de mayúsculas y nombres.

La depuración es un mal necesario que un desarrollador encontrará con frecuencia a lo largo de su carrera. ¿Por dónde empezar si tu código base está desordenado y desorganizado? Cuando el código fuente tiene el formato y la sangría adecuados, parece menos agrupado. Esto facilita determinar dónde se encuentran los diferentes módulos de la aplicación. En consecuencia, resulta más fácil encontrar problemas y errores. El reformateo del código en IntelliJ IDEA se basa en los requisitos especificados en la configuración de estilo de código en el IDE. Sin embargo, cuando usa EditorConfig en su proyecto, las configuraciones que especifique en el archivo .editorconfig anularán de forma predeterminada las especificadas en la configuración de estilo de código. Reformatear en IntelliJ no es diferente de trabajar en otros IDE. Hay opciones para reformatear tanto un solo bloque de código como todo el archivo. Puede haber ocasiones en las que todo el bloque de código sea bastante largo y desee reformatear todo excepto algunas áreas específicas. En este caso, elegir individualmente las partes del código que desea formatear definitivamente no es la mejor opción. En tales situaciones, reformatear con IntelliJ definitivamente será útil. Exploraremos este y otros usos del IDE.

Consejos para formatear código

Veamos algunos consejos básicos para formatear código en general:

• Asegúrese de que su código esté comentado correctamente. Utilice comentarios para transmitir intención y significado. Incluso si usted es el único que lee este código, es útil recordar el propósito de ciertos bloques de código. Esto facilitará las cosas si regresa a su código base después de unas vacaciones, por ejemplo.

• No utilice tabulaciones para espacios en la misma línea. Esto reduce la legibilidad del código.

• Agregue un TODO a sus bloques de código para realizar un seguimiento de futuras implementaciones. De esta manera, cuando reformatees tu código, no crearás la ilusión de que tu trabajo está completo.

• No utilice el reformateo del código como solución rápida para errores de sintaxis.

• Evite inversiones profundas. Esta es una práctica común entre algunos desarrolladores, pero el código profundamente anidado dificulta su lectura e introduce errores que no son fáciles de detectar a primera vista.

Reformateo de código en IntelliJ IDEA

Antes de explorar diferentes formas de formatear código en IntelliJ, comience creando un proyecto Java de muestra en su IDE. Una vez que inicie IntelliJ, debería ver una pantalla como esta: Haga clic en Siguiente y complete la configuración de inicialización del proyecto. Ahora que su proyecto está configurado, es hora de agregar código de muestra para ayudarlo a comprender el formateo del código en IntelliJ. Este es un sencillo contador de palabras de la Universidad de Texas:

import java.io.File;
import java.io.IOException;
import java.util.Map;
import java.util.Scanner;
import java.util.TreeMap;

public class SimpleWordCounter {
    
    public static void main(String[] args) {
        try {
            File f = new File("ciaFactBook2008.txt");
            Scanner sc;
            sc = new Scanner(f);
            // sc.useDelimiter("[^a-zA-Z']+");
            Map<String, Integer> wordCount = new TreeMap<String, Integer>();
            while(sc.hasNext()) {
                String word = sc.next();
                if(!wordCount.containsKey(word))
                    wordCount.put(word, 1);
                else
                    wordCount.put(word, wordCount.get(word) + 1);
            }
            
            // show results
            for(String word : wordCount.keySet())
                System.out.println(word + " " + wordCount.get(word));
            System.out.println(wordCount.size());
        }
        catch(IOException e) {
            System.out.println("Unable to read from file.");
        }
    }
}

Reformatear fragmentos de código

Comencemos formateando los fragmentos de código. Para hacer esto, simplemente resalte la parte del código que desea formatear y haga clic en Código > Reformatear código . Como puede ver, la parte resaltada de su código (en este caso, las líneas 11 a 17) tiene el formato correcto. Veamos el "antes" y el "después" de reformatear nuestro fragmento de código. Si notó en la primera imagen, la declaración y la inicialización de su variable ocurrieron en la misma línea que try . Las llaves de cierre se mezclan con el bloque else . Pero después de resaltar esta parte de su código y usar la opción de reformateo, terminará con un bloque de código que es más agradable a la vista. El código completo para su clase ahora se parece a esto: Observe que solo se ha reformateado el bloque de código que seleccionó.

Reformatear archivos completos

Para reformatear todo el archivo, abra el editor, coloque el cursor en cualquier lugar y haga clic en Código >Reformatear archivo . Se le pedirá que seleccione las opciones de formato apropiadas para todo el archivo. Esta acción reformateará todo su código en el editor activo. Su código será algo como esto:

Reformatear un módulo o directorio

Para hacer esto, todo lo que necesita hacer es hacer clic derecho en el módulo en la ventana de herramientas del proyecto y seleccionar Reformatear código . En la ventana emergente, seleccione cualquiera de las tres opciones que necesite:

• Optimizar importaciones : seleccione esta opción si desea agregar declaraciones de importación faltantes y también deshacerse de las importaciones no utilizadas.

• Reorganizar entradas : para reorganizar el código de acuerdo con las reglas de diseño especificadas en la configuración de estilo de código.

• Código de limpieza : para ejecutar la limpieza del código.

Cuando haya terminado, simplemente haga clic en Aceptar.

Excluir código del reformateo

Veamos qué hacer si tiene un bloque de código que no desea incluir al formatear todo el archivo. Vaya a Archivo > Configuración o utilice el método abreviado de teclado Ctrl + Alt + S. Vaya a Editor > Estilo de código y marque Habilitar marcadores de formateador en el menú de comentarios de la pestaña Control de formateador . En su editor, cree una línea de comentario y escriba //@formatter:off sin comillas al principio del área que desea excluir. Al final del área, cree otra línea de comentario e ingrese //@formatter:on , también sin comillas. En la imagen de arriba, puede ver que el formateador ignorará su código en la línea 23 simplemente porque lo especificó en los comentarios y el controlador de formato.

Ejemplos de teclas de acceso rápido para reformatear

• Reformatear bloque de código: Ctrl + Alt + Shift + L
• Reformatear archivo: Ctrl + Alt + L
• Agregue un comentario a la línea: Ctrl + /
• Agregar comentario de bloque: Ctrl + Shift + /

Conclusión

Prestar atención a los formatos del código es tan importante para un desarrollador como hacerlo funcionar. Nunca se sabe quién terminará trabajando en su código. Tener una base de código bien estructurada y fácil de leer habla de un desarrollador profesional. Con IntelliJ IDEA, formatear su código no tiene por qué ser tan difícil como escribir el código mismo. La próxima vez que escriba código con IntelliJ, utilice estos consejos. Esto le facilitará la vida al depurar su código.