Hervera
Open Menu
Listado de consejos y buenas practicas aplicables a cualquier lenguaje de programación y en desarrollo de software en general. Este es una selección de las que considero esenciales.

Al terminar el último proyecto en que he participado, que por cierto, ha terminado con éxito ♥, hemos hecho una retrospectiva para corregir y mejorar todas las practicas posibles a mejorar cuando empiece el próximo.
De ahí ha salido también un listado de buenas prácticas esenciales que a continuación describo.
Son transversales por lo que sirven para cualquier tecnología. Para cualquier comentario, corrección o propuesta de mejora, aquí dejo el enlace de github: Buenas prácticas

  1. Single Responsibility Principle (SRP) Según este principio, cada elemento en programación sirva únicamente para una objetivo especifico.
    Por lo tanto, un método save(), solo va a guardar los datos. Si además se tiene que enviar un mail informando del cambio, se creará un método a parte.
  2. KISS - Keep it simple, stupid Como dice la misma frase, hay que hacerlo sencillo. Todo. Como mas sencillo, mas mantenible, mas escalable, mas testeable. En el futuro te lo agradecerás.
  3. DRY - Don't repeat yourself No te repitas. De esta forma el código que hagas, será mucho más mantenible, ya que solo estará una vez. Mas escalable, ya que solo estará una vez. Mas testeable, ya que solo estará una vez. ya que solo estará una vez. ya que solo estará una vez.
  4. Nomenclaturas - Escribir en modo prosa Como dice "Uncle Bob" en el libro "Clean Code", nos pasamos el 80% del tiempo leyendo código y solo un 20% escribiendolo. Por eso primaremos que el código se entienda sobre que sea fácil de escribir.
    Es una buena practica poner en el nombre de las funciones todo lo que hacen, si vemos que nos queda demasiado largo, hay que plantearnos si nos estamos saltando la norma SRP.
    person.crtDoc();                   -> incorrecto
    person.createDocumentation()       -> correcto
    
  5. Convenciones Todos los lenguages suelen tener unas convenciones que dictan la forma de escribirlo, JAVA, JavaScript - (no tiene unas directamente, pero se puede usar las de google) C#. Es conveniente seguirlas, de esta forma el código de todo el equipo sera homogéneo.
  6. Separación de capas Las aplicaciones de software, suelen estar divididas por capas lógicas (Controladores, Servicios, Persistencia...). El no respetarlas, no siempre significa que el código no "funcione".
    Podemos hacer una consulta en un controlador, pero aunque parezca más rápido, hará que incumplamos muchas de las buenas practicas descritas y por tanto a la larga (o no tan larga) será una gran perdida de tiempo y un incremento de dolores de cabeza.
  7. Deja el bosque (código) mas limpio de lo que lo encontraste Cuando nos ponemos a resolver un problema en un código o a hacer un evolutivo, muchas veces nos encontramos con que lo que aya está hecho, no sigue los principios de buenas prácticas.
    Suele ser más cómodo seguir tal y como está, pero es altamente recomendable realizar nuestra labor de la mejor manera posible y arreglar lo que esté mal. De esta forma, se equilibra el estropeo al que tiende el software de forma natural.
  8. Escribe código que NO necesite ser documentado Si seguimos todas las buenas prácticas aquí escritas, nuestro código no debería necesitar comentarios explicativos, ya que debería entenderse por sí solo.
    El principio no dice que no se deba comentar el código, si no que cuando se necesite documentar una función/objeto/código derbería de saltar la alarma, ya que igual estamos saltandonos alguna de las buenas prácticas anteriores.

Fotografía de portada de: unsplash-logoPatrick Perkins