BLOG

¿Cómo documentas tus proyectos?: Esquemas (I)

Por fgutierrez.velneo el | 3 Comments

Una de las partes más importantes de la programación es la documentación de nuestros proyectos, de nuestro código, y en ella Velneo V7 también nos puede ayudar mucho. Aunque la forma en que se programa en Velneo ya ayuda mucho a entender el funcionamiento de lo que hemos programado.

No es sólo importante para que otros programadores que accedan a nuestro código lo entiendan, si no que nosotros mismos, después de un tiempo, podemos necesitar un poco de ayuda para volver a entenderlo, sobre todo en aplicaciones complejas.

A lo largo de tres artículos veremos las herramientas de que disponemos, qué puntos podemos documentar nuestros proyectos y qué funcionalidades tenemos al respecto.

El uso de esquemas para la definición de estructuras de tablas y la forma en que se trabaja con objetos visuales, el código asistido cuando programamos procesos, los inspectores ¿dónde se usa?, ¿qué usa?, el inspector de errores, etc., hacen ya más asequible entender a primera vista cómo funciona una aplicación.

Pero tenemos muchas formas de aclarar aún más su funcionamiento. Vamos a ver las que podemos usar y cuándo puede ser interesante hacer uso de ellas.

Formas de documentar

Las tres formas de documentar nuestras aplicaciones son:

Los esquemas nos permiten documentar de forma visual las estructuras de datos que programemos en nuestros proyectos de datos.

Los comentarios son una propiedad que tienen todos los objetos y que nos permite realizar anotaciones sobre su uso.

La última opción, como ya sabréis, nos permite añadir comentarios en las líneas de código de procesos, funciones de proceso, eventos, etc., a fin de documentar su funcionamiento.

En este primer artículo, vamos a centrarnos en la documentación de estructuras de datos mediante esquemas.

Esquemas

Flecha roja. Enlace a plural.Los esquemas nos permiten mostrar las relaciones entre las tablas que componen nuestro proyecto de datos, por medio de flechas que indican por su color, el tipo de enlace.

Así, las flechas rojas nos indicarán una relación de plural (de 1 a n) entre la tabla maestra y la tabla plural.

Flecha azul. Enlace a maestroUna flecha de color azul nos indicará un enlace a maestro desde el plural (1 a 1). También se verán reflejados en azul los punteros indirectos y los enlaces a de una tabla a si misma.

Flecha azul. Enlace a si misma

Organización

Normalmente colocaremos las tablas de forma arbolada, haciendo que los plurales (flechas rojas) apunten hacia abajo, y los enlaces a maestro, en azul, hacia arriba.

De esta forma, visualizar el flujo de la información se hace muy sencillo, detectando rápidamente qué tablas contienen más información y más detalle (las plurales, las de la parte de abajo), qué tablas son las tablas maestras que categorizan la información (las que se encuentren arriba), quedando en medio, también abajo, sobre todo las tablas de unión que permiten enlaces de doble plural (n a n).

Comentarios con texto enriquecido

El objeto esquema, además, nos permite introducir información en forma de comentarios, por medio de texto enriquecido formateado, que puede ayudarnos a aclarar las relaciones entre las tablas, los grupos de tablas más importantes, etc.

Ejemplo de esquema del proyecto de la estructura para compras de vGestion

Ejemplo de esquema del proyecto de la estructura para compras de vGestion

Imágenes

También podremos añadir imágenes, bien objeto Dibujo, bien  objeto SVG, por lo que podremos incluir gráficos que ayuden a entender mejor su funcionamiento.

Si asignamos iconos a las tablas que se presentan en los esquemas, nos facilitará en gran medida entenderlos. Estos iconos son objetos dibujo que hayamos incluido en nuestros proyectos.

Ejemplo de esquema del proyecto de la estructura de maestros de vGestion

Ejemplo de esquema del proyecto de la estructura de maestros de vGestion

Tantos esquemas como queramos

Lo interesante, además, es que podemos crear tantos objetos Esquema como queramos, lo que nos permite realizar diferentes esquemas para detallar aquellas partes de la estructura en que queramos enfatizar, o bien permitiendo mostrarla de forma más simple, presentándola por partes en vez de mostrar todas las tablas en un mismo esquema lo que, en un proyecto de datos con muchas tablas podría dificultar su entendimiento más que favorecerlo.

Continuará en: ¿Cómo documentas tus proyectos?: Propiedad Comentario (II)

Velneo es el entorno ágil para el desarrollo
de aplicaciones empresariales

PRUEBA VELNEO

3 Responses to "¿Cómo documentas tus proyectos?: Esquemas (I)"
  1. Antonio dice:

    Hola que tal, muy interesante el tema !! Salu2
    =)

Deja un comentario

Este sitio web utiliza cookies para que usted tenga la mejor experiencia de usuario. Si continúa navegando está dando su consentimiento para la aceptación de las mencionadas cookies y la aceptación de nuestra política de cookies, pinche el enlace para mayor información. ACEPTAR

Aviso de cookies