Programar con abreviaturas

Una de las decisiones más importantes que deben tomarse cuando se comienza a desarrollar con una plataforma es la nomenclatura que daremos a los identificadores de los diferentes elementos que debemos crear para el desarrollo de nuestras aplicaciones.

Las nomenclaturas alcanzan a todos los ámbitos de la programación ya que es conveniente tener reglas para nombrar de forma clara y precisa desde una carpeta del disco donde almacenaremos nuestro solución hasta la variable local más insignificante.

Una buena nomenclatura proporciona grandes beneficios:

  • Facilita la comprensión clara del concepto.
  • Evita ambigüedades.
  • Facilita la organización.
  • Facilita la localización.
  • Facilita el mantenimiento.
  • Permite la comprensión de otros desarrolladores.
  • Reduce el tamaño de los identificadores.

Todas estas ventajas están muy bien, sin embargo, cuando empezamos a trabajar con un nuevo lenguaje no siempre es sencillo saber qué nomenclaturas debemos utilizar. Me gustaría aprovechar este artículo para indicar 3 recomendaciones sobre el uso de nomenclaturas en Velneo V7.

1ª) No tengas 2 proyectos con el mismo nombre

Cuando creamos una solución desde el asistente y nos pide el nombre de los proyectos de aplicación y datos, podemos tender a darles el mismo nombre. En principio parece lógico ya que son de diferente tipo y cada uno cumple una función específica. Sin embargo, no debemos obviar que existen objetos que pueden ser creados en ambos proyectos (procesos, funciones, búsquedas, esquemas, etc.) Si no tenemos la precaución de darles un nombre diferente nos podemos encontrar con un objeto llamada [email protected]. Y entonces es cuando comienzan tus problemas para discernir de qué objeto se trata y donde puedes encontrarlo, este mismo ejemplo lo puedes aplicar a cualquier circunstancia en la que tengas que trabajar a nivel del proyecto Gestion, que no podrás identificar si es el de aplicación o el datos. La recomendación que te hago es de añadir un prefijo o sufijo a tus nombres de proyectos donde identifiques el tipo. En nuestro ejemplo podríamos crear GestionApp y GestionDat, lo que supondría que la búsqueda anterior tendría como identificador [email protected] o [email protected], lo que no daría lugar a dudas.

2ª) Usa abreviaturas en los identificadores de objetos

Nadie duda de que es más sencillo leer y entender el identificador CLIENTES que el identificador CLT. Sin embargo esa ventaja inicial se puede volver en nuestra contra en proyectos de envergadura.

Hay que tener presente que no sólo usan identificadores las tablas, también tenemos que usarlos en los objetos visuales y, es práctica habitual los objetos visuales contengan en su identificador la tabla origen del mismo. Esto pueden generar identificadores realmente largos.

Identificadores largos

Pros

  • Fácil comprensión.

Contras

  • Mayor tamaño de nuestro código.
  • Identificadores cortados en propiedades.
  • Identificadores compuestos muy largos.

Identificadores abreviados

Pros

  • Menor tamaño en nuestro código.
  • Identificadores que se ven completos en propiedades.
  • Identificadores compuestos cortos.

Contras

  • Requiere más conocimiento para su comprensión.

Vamos a ver un ejemplo en ambos casos:

Nomenclatura sin abreviar

  • Tabla: CLIENTES
  • Búsqueda: CLIENTES_NOMBRE_SIN_FORMULARIO
  • Identificador compuesto: [email protected]

Nomenclatura abreviada

Si ahora te imaginas estos identificadores en el árbol de propiedades comprenderás que sin abreviar, la mayoría de los identificadores de objetos no estarán visibles de forma completa salvo que trabajes con una resolución de pantalla muy elevada. Además, tus fórmulas serán más largas y más complicadas de escribir.

 

Cuando desarrollan varios programadores en un equipo de trabajo el uso de nombres largos completos suele llevar a la ambigüedad algo que se puede evitar con el uso de abreviaturas, eso sí, siempre que las abreviaturas estén  documentadas.

3ª) Usa un diccionario de abreviaturas

Como se comenta en la recomendación anterior, para que el uso de abreviaturas sea válida debe ir acompañada del uso de un diccionario de abreviaturas.

En Velneo utilizamos la Open App vEstandar para documentar nuestras normas de programación y también las abreviaturas a usar por lo desarrolladores. En la ficha de la Open App también encontrarás los documentos PDF correspondientes a dicha información.

Te recomiendo que utilices esta Open App o una aplicación similar a la que todos los desarrolladores tengan acceso para buscar, consultar y crear nuevas abreviaturas. Es importante ser estrictos en el uso del diccionario para evitar duplicidades o errores en el código.