Introducción

Este documento proporciona el coding style para el código PLC que compone el core de PLC Framework.

¿Por qué un ‘coding style’?

Si os habéis fijado, no existe un estilo único para programar PLC y el problema es de base porque cada proveedor nombra a sus elementos como bien puede, además los primeros programadores de PLC no eran programadores de código de alto nivel (c, c++, java, python, etc.) sino en su mayoría eran ingenieros eléctricos o electrónicos por lo cual cada uno programaba como mejor podía.

¿A qué me refiero? A que cada programador, equipo, empresa, tiene su manera de nombrar a las variables, constantes, tipos de datos, funciones, etc. No existe una separación clara entre función, subrutina y por no mencionar el uso erróneo del término macro.

Esta situación no pasa con el resto de los desarrolladores, como por ejemplo backend, frontend, ellos trabajan con frameworks y guías de estilo del código claros y específicos.

¿Cómo llamarías a la variable 'is running'?

IS_RUNNING
is_running
Is_running
Is_Running
isRunning
IsRunning
is-running
Is Running 😱😱😱
isRng
Is_rng

¿Cómo llamarías a la constante 'status done'?

status_done
Status_Done
STATUS_DONE
statusDone
STATUS-DONE
statusDone

Y así, hasta agotar todas las posibilidades, todas lógicas, todas lícitas y sin embargo sin reglas claras 😔.

Para nosotros el coding style es tan importante como el código en sí. Es por eso que, los primeros capítulos de la documentación los dedicaremos al coding style.

Antes de empezar

El coding style de nuestro framework se basa en los siguientes estilos:

🐫 Camel Case El estilo Camel Case se utiliza para nombrar variables, funciones y otros elementos de manera que cada palabra dentro del nombre comience con una letra mayúscula, sin espacios ni guiones. Por ejemplo: "MiVariableEjemplo". Este estilo mejora la legibilidad al destacar cada palabra dentro del nombre, facilitando su comprensión y uso en el código. Existen dos variantes: Lower Camel Case y Upper Camel Case (Pascal Case).

🐍 Snake Case El estilo Snake Case se utiliza para nombrar constantes, funciones y otros elementos de manera que cada palabra dentro del nombre esté separada por guiones bajos (_). Por ejemplo: "mi_variable_ejemplo". Este estilo mejora la legibilidad al separar claramente cada palabra dentro del nombre, facilitando su comprensión y uso en el código. Existen dos variantes: Lower Snake Case y Upper Snake Case (Screaming Snake Case).

🍢 Kebab Case El estilo Kebab Case se utiliza para nombrar elementos de manera que cada palabra dentro del nombre esté separada por guiones (-). Por ejemplo: "mi-variable-ejemplo". Este estilo mejora la legibilidad al separar claramente cada palabra dentro del nombre, facilitando su comprensión y uso en el código. Es comúnmente utilizado en nombres de archivos y URLs.

¡Empecemos! 🏁