Imprime tu código. En papel.

Foto de portada CC-BY-SA 4.0, por Corvair

Leer código es un trabajo duro, en cierto modo más difícil que escribirlo, por lo que la mayoría de nosotros tendemos a evitar mirar de cerca. Hay una práctica que aprendí hace mucho tiempo llamada verificación de escritorio que parece haber caído en desgracia en un mundo de IDE increíblemente sofisticados, pero creo que todavía tiene mucho valor.

Al escritorio verifique su código:

  1. Imprimirlo
  2. Encuentra una habitación tranquila
  3. trae un lápiz
  4. Deja todos los dispositivos atrás. Quítate el reloj inteligente. Dobla tu computadora portátil. Deje su teléfono en su escritorio. Esto es entre usted y el código.
  5. Siéntate ahí y lee tu código línea por línea. Márcalo a medida que avanzas.

Aprenderás algo cada vez que hagas esto.

Aquí hay algunas preguntas que puede hacer:

  • ¿Están bien las etiquetas? Hay muchos más matices en inglés que, digamos, en Python, por lo que se deduce que muchos defectos en el código provienen de malentendidos en inglés entre programadores, en lugar de malentendidos de Python. En el otro lado de la moneda, el código es una oportunidad para alinear nuestros modelos mentales y el vocabulario del dominio del problema con nuestros compañeros de equipo. Esto puede ser muy filosófico.
  • ¿Son correctas las abstracciones? ¿Qué sabemos ahora sobre el dominio del problema que no estaba tan claro cuando se escribió este código? Dado lo que sabemos ahora, ¿cómo podemos acercar este código a nuestra comprensión actual?
  • ¿Qué refactorizaciones simples aportarían más claridad y elegancia al código? ¿Qué ya no se necesita, que antes anticipábamos necesitar? ¿Qué se puede descomponer más?

También encontrarás errores, naturalmente. Cuando reduce la velocidad y mira, los errores simplemente comenzarán a arrastrarse fuera de la página. A veces te dejarán sin aliento y te irás preguntándote cómo funcionó esa maldita cosa en primer lugar.
Cómo imprimir código, con resaltado de sintaxis:

Hay una utilidad de línea de comando antigua pero útil para esto, llamada enscript.

En MacOS, deberá brew install enscript primero.

En Linux, es posible que ya lo tengas. Si no, busca el paquete. enscript o descargarlo aquí.

Para imprimir su código, ejecute:

enscript -1rG --line-numbers -p out.ps --highlight=python \
  -c inputfile.py

El archivo de salida se verá así:

enscript salida.png

Luego puede abrir out.ps (en MacOS para abrir en su visor PostScript predeterminado) o imprimirlo en su impresora predeterminada con lpr out.ps.

Enscript tiene muchas opciones. Estas son las opciones más valiosas:

-1 -2 -3 -4 número de columnas por página
-r rotar (modo horizontal)
-G encabezado elegante (con nombre de archivo, fecha y hora)
--color=1 si tienes una impresora a color
-w html si desea una salida HTML en lugar de PostScript
--help-highlight mostrará qué idiomas tienen resaltado de sintaxis disponible

Aquí hay una versión bonita que agrega --color=1 y -2. Si las longitudes de sus líneas no están fuera de control, este es un buen punto de partida.

enscript -2rG --line-numbers -p out.ps --highlight=python \
  --color=1 -c inputfile.py

enscript salida 2.png

El código puede ser bastante hermoso en reposo, si se toma el tiempo para apreciarlo realmente.

Tienes las herramientas, ahora aparta el tiempo.

Fuentes:
Código de impresión en MacOS
Guía de impresión de Linux

Similar Posts

Leave a Reply

Your email address will not be published.