Escribiendo código reciclable

La gran mayoría del código que escribimos está destinado a servir a un solo propósito y, una vez empleado en ese propósito, nunca vuelve a ver la luz. Sin embargo, es un desperdicio de su valioso tiempo, cuando es perfectamente posible escribir su código de tal manera que pueda ser reciclado y puesto en uso para muchos propósitos diferentes.

El desafío es que escribir un código reciclable es bastante diferente a escribir lo que podría denominarse código "desechable". Con el último tipo de código, solo necesita preocuparse por cómo otros humanos interpretan las instrucciones de su código si no las ha escrito a la perfección. Sin embargo, cuando escribe un código reciclable, debe hacerlo de una manera muy específica, y realmente necesita pensar en cómo alguien, incluido usted mismo, entenderá el código que ha escrito en algún momento en el futuro.

Hacer las cosas de esta manera requiere mucho más tiempo y esfuerzo que la codificación normal, sin embargo, tiene la ventaja de que nunca tendrá que escribir la misma función dos veces. Como se indicó, deberá hacer todo de cierta manera para asegurarse de que su código realmente pueda ser usado nuevamente para otros propósitos.

Vale la pena mencionar que el código reciclable no es necesariamente lo mismo que un complemento. Cuando creas un complemento, estás desarrollando un código que cualquiera puede tomar e incorporar en su sitio web y generar fácilmente algún efecto a partir de solo unos pocos parámetros.

El código reciclable es diferente en el sentido de que no es necesariamente estático y no está necesariamente destinado a la distribución fuera de su propia organización. Pase lo que pase, es esencial asegurarse de utilizar el proceso correcto, que se describe a continuación.

1. Conviértete en un maestro de la organización

Cuando creas código con la intención de que luego puedas reutilizarlo, eso no te ayudará mucho si no lo encuentras. Debe hacer un buen trabajo de nombrar, almacenar y clasificar sus archivos de código.

2. Sea consciente de lo que es "aplicación específica" y lo que es "genérico"

Casi siempre habrá algún código que sea realmente específico para su aplicación particular y no se podrá utilizar de ninguna otra manera. A medida que creas cada fragmento de código, debes decidir si es un código genérico o específico de la aplicación. En última instancia, desea crear mucho más de lo último que lo anterior, y hay una buena manera de hacerlo que describiré en el paso 3.

3. Código separado de los valores.

Los valores variables codificados de forma rígida pueden presentar un problema cuando se desea utilizar el código de nuevas formas. Una mejor manera de hacerlo es almacenar los valores de las variables iniciales en algo como un archivo CSV y luego cargar esos valores cuando se inicia la aplicación. Este método también le permite cambiar fácilmente los valores de las variables iniciales sin alterar su archivo de código original.

4. Trate de no codificar los valores que no tienen que ser absolutamente

Básicamente, esto significa que no debe codificar ningún valor en absoluto, con una excepción que es el nombre del archivo que se cargará con todos los valores codificados. Ese archivo siempre debe ser accesible en relación con la ruta raíz de la aplicación, o podría tener problemas si mueve los archivos a un sistema operativo diferente.

5. Evita poner espacios en los nombres de archivos

Solo porque puedas poner espacios en los nombres de los archivos no significa que debas. Puede potencialmente crear problemas para usted si mueve sus archivos a un sistema operativo o sistema de archivos diferente. Por ejemplo, si mueve sus archivos de ext4 a FAT, podría encontrar problemas. Curiosamente, el sistema operativo Windows mostrará los nombres de los archivos con caracteres ilegales, pero no le permitirá ningún acceso a esos archivos, incluso si todo lo que quiere hacer es cambiarles el nombre.

5. Comenta todo verbalmente

En el momento en que escribes tu código, sabes exactamente lo que va a hacer. Pero deje pasar algunos años y es muy posible que haya olvidado sus intenciones. Es la misma historia también cuando estás usando el código de otra persona, porque a menos que hayan proporcionado comentarios detallados, tendrás que pasar momentos preciosos analizando e interpretando lo que han escrito.

6. Evita crear dependencias.

Una de las fallas más grandes en la mayoría de los escenarios de código reutilizables es que puede terminar con enormes cadenas de dependencias de archivos. Esto sucede porque las personas escriben sus fragmentos de código de maneras específicas y las incluyen en un orden específico sin documentar por qué. Luego, antes de que te des cuenta, terminas con un escenario de Left-Pad y todo el mundo entra en pánico cuando algún fragmento de código del que depende tu aplicación va sin permiso por alguna razón.

Puede evitar este tipo de fusión asegurándose de que cada trozo de código se pueda intercambiar fácilmente por otro, documentar como locos y, por supuesto, hacer copias de seguridad de cada trozo.

La documentación debe incluir qué es un archivo, qué hace y por qué se carga en el lugar particular en que se carga. Esto elimina posibles problemas de dependencia, ya que cualquier parte del código puede recrearse porque su propósito es conocido.

7. Formato de todo su código muy bien

Obviamente, es una buena idea hacer esto siempre de todos modos, pero es especialmente importante hacerlo cuando se escribe un código reutilizable. También debe mantener un estilo de codificación muy consistente y no cambiarlo. Por ejemplo, si tiende a escribir sus nombres de constantes en mayúsculas y nombres de variables en camelCase, debe hacerlo con una consistencia absoluta.

8. Cada trozo de código tiene un propósito específico

Tu misión es entender cuál es ese propósito. Tienes que evitar permitir múltiples propósitos por trozo. Entonces, por ejemplo, si tiene una porción de código que se carga en los valores de las variables iniciales, no debería hacer nada más aparte de eso. Su siguiente fragmento de código debe estar manejando la siguiente operación requerida. ¿Qué tan estricta es esta regla? Bueno, su función principal no debería hacer nada más que hacer llamadas a todas las demás funciones.

Es mucho más difícil escribir bien reciclable bueno de lo que cualquiera podría pensar antes de intentarlo. Sin importar cuáles sean sus intenciones iniciales, es probable que encuentre que aproximadamente el 80% del código que escribe terminará siendo específico de la aplicación en lugar de genérico. La mayoría de las personas se entusiasman con el código reciclable sin tener ni idea de cómo lo usarán en el futuro, y el resultado final es que crean más trabajo para ellos mismos, que es lo contrario de la meta. Esperemos que este artículo te haya ayudado a evitar ese destino.

imagen del encabezado cortesía de DKNG

Bogdan Rancea

Bogdan es miembro fundador de Inspired Mag, habiendo acumulado casi 6 años de experiencia durante este período. En su tiempo libre le gusta estudiar música clásica y explorar artes visuales. También está bastante obsesionado con los fixies. Ya es dueño de 5.