Programar con lenguaje natural en Dynamics NAV

Post blog
agosto 1, 2016
Categoría: Sin categoría

Imagínate la situación:

Llama un cliente porque una factura no registra.
Tienen un camión esperando en la puerta.
El consultor que lleva a este cliente no está en la oficina.
Todo el mundo está nervioso.

Te ha tocado el marrón

Le haces algunas preguntas al usuario para situarte y decides que vas a tener que revisar el código para saber qué narices está pasando.

Ves a mirar el código y te encuentras una función de más de 250 líneas que no hay por donde pillarlas.

¿Alguien sabe decirme, a simple vista, que se supone que hace esta función?

Un programador avispado diría: FALTAN COMENTARIOS

No hay lugar a dudas, los comentarios ayudan mucho. Se podría haber puesto una frase explicativa delante de cada bloque importante de código.

Sin embargo la estrategia de los comentarios sigue teniendo un problema importante: No se ve a simple vista.

Detrás de cada uno de los comentarios pueden venir 50 líneas de código. Hay que andar moviendo el ratón arriba y abajo para ver qué está pasando en cada momento.

No es cómodo.

La solución definitiva: usar el lenguaje natural

Fíjate ahora en este código:

Lo que hemos hecho ha sido:

  • Dividir las +250 líneas en pequeños trozos
  • Crear una función para cada uno de los trozos
  • A cada función darle un nombre auto descriptivo.

Fíjate que el nombre de las funciones recuerda mucho al lenguaje natural.

No es necesario poner comentarios porque todo el mundo puede entender lo que hace la función.

NOTA:
Siempre que puedas usa nombres de funciones y variables en inglés. Nunca sabes quién va a mirar el código después de ti.
Si por el motivo que sea, decides usar el español, nunca nunca uses acentos, eñes, o cualquier otro carácter “extraño”.

120 caracteres para nombrar las funciones con lenguaje natural

En versiones anteriores solo tenías 30 caracteres (1) para darle un nombre a tus funciones.

Reconozco que era fácil quedarte corto.

En nuevas versiones ya dispones de hasta 120 caracteres (2). Da para mucho.

  1. Revisado en NAV 2009
  2. Revisado en NAV 2016

Pero… ¿y yo que gano con esto?

Quizá estés pensando: Yo entiendo mi propio código. Si me cambio al lenguaje natural, solo ganan los demás. Yo me quedo igual.

Pues no. No es así. Tú también ganas mucho. De entrada porque pasados 6 meses a ti también te cuesta seguir tu propio código.

Además, piensa que si has desarrollado una cosa que solo entiendes tú, cuando surja cualquier problema siempre acudirán a ti.

Aunque sea sábado.
Aunque estés de viaje por negocios (al llegar al hotel, toca conectarse).
Aunque estés de vacaciones.
Aunque estés concentrado en otro proyecto importante.

Ya ves. Se trata de ti. Te haces un favor si escribes código que los demás sepan interpretar. Empieza hoy mismo, nunca es tarde.

Salut!
Laura Nicolàs

Debe iniciar sesión para crear nuevos temas.

Comentarios