Paradigmas de programación

Paradigmas de programación

“Un paradigma de programación es un marco conceptual, un conjunto de ideas que describe una forma de entender la construcción de programa, como tal define: Las herramientas conceptuales que se pueden utilizar para construir un programa (objetos, relaciones, funciones, instrucciones).”

Atributos de un Buen Software:

• Mantenibilidad: debe escribirse de manera que  pueda evolucionar.

• Confiabilidad: debe ser fiable, seguro y tener mecanismos de protección.

• Eficiencia: No debe malgastar los recursos.

• Usabilidad: Debe ser fácil de utilizar.

¿Para qué sirve un código limpio?

- Mantenimiento.

- Reusabilidad.

- Reconocimiento Profesional.

- Evitar Críticas.

- Satisfacción Personal.

Índice

Buenas prácticas

1. Lineamientos y requerimientos bien formulados.
2. Patrones de Diseño de Interfaz.
3. Código Simple.
4. Objetos
5. Comentarios.

1. Comentarios código fuente
2. Comentarios en los encabezados de formularios
3. Comentarios Base datos Procedimientos

1. Nombres de Proyectos
2. Nombres de Formularios
3. Nombres y naturaleza de los Datamodulos
4. Variables
5. Constantes
6. Begin – end;
7. Funciones condicionales anidadas
8. Bucles
9. Duplicidad de Código
10. Procedimientos
11. Funciones
12. Hit o leyenda en las grillas
13. Try - except
14. Commit,  rollback
15. Mensajes informativos,  de Advertencias, de Confirmación y de errores
16. Funciones y Variables Boolean
17. Testeo de Código

1. Lineamientos y requerimientos bien formulados

• Antes de comenzar a desarrollar es necesario tener claro los requerimientos y el software que se va a desarrollar, despejar todas las dudas y procesos a realizar; para esto es necesario recibir un documento de requerimientos amplio y claro recolectando toda la información necesaria para empezar el proyecto.
• Un buen documento de requerimiento garantizara el éxito del software, ya que si no se tiene de manera clara  podría con llevar a funcionalidades incorrectas, cambios de codificación y procesos.

[pic 1]

1. Patrones de Diseño de Interfaz

•  Desarrolla todas las interfaces con los mismos patrones de diseño como maquetas de formularios,  ubicación de botones, grillas de datos, posiciones de formularios, capturas de datos, utilización de Datamodulos para objetos no visuales, colores de formularios, formas inserción de registros a la base de datos, formas de consultas de datos, modelos de reportes.
• De esta manera crearas un patrón de diseño compacto y  sencillo para que un tercero o nosotros mismos podamos reutilizar o llevar un parámetro de programación y diseño.

[pic 2]

1. Código simple

• Tratar de hacer lo más simple el código, has las cosas fáciles, lo más simple posible en operaciones que no requieren complejidad, tratar de reducir al maximo la codificación.

• Ejemplo:

              * No vamos a desarrollar una función para obtener PI, cuando ya existe esa función.

* para saber si un query tiene datos no  vamos a comparar la cantidad del campo devuelto          cuando el recordcount nos informa si existen datos.

1. Objetos

- los objetos visuales y no visuales deben ser inicializados con la abreviatura que mas describa al objeto , seguido del nombre de ese objeto.

Ejemplo

1. Comentarios

1. Comentarios código fuente

• Los comentarios nos ayudaran a que nuestro código sea más entendible por nosotros mismos y por terceros; no es necesario comentaríar todo el código, solo partes esenciales, procesos, variables abstractas o funciones especifica.

Ejemplo1:

//esta función recorre las órdenes sumando todas las cantidades en un rango de fecha determinada arrojando el total

Function fn_obtenertotalizadosOrdenes:double;

Begin

       For  i:=0 ….

              Sum :=…

      End;

  Result := total;

End;

Ejemplo2:

Var   VSumOrdenesVenc : Double ;   // importante: variables para obtener el total de ordenes vencidas

1. Comentarios en los encabezados de formularios

• Es buena práctica comentariar en el encabezado de un formulario el creador, fecha, y motivo o funcionalidad de creación del formulario, los objetos de base de datos que conectan con el formulario.
• Ejemplo:  

                  /* Form Creado por: ing. Abraham de la barrera

                      Fecha creación: 13-06-2020

                       Funcionalidad: formulario para asociar clientes a usuarios.

                      Objetos bases datos asociador: t_clientes, sp_obetener_promedios;

                 */

1. Comentarios Base datos Procedimientos

• A nivel de base de datos cuando se crea un procedimiento almacenado o un  trigger es buena práctica comentariar  el creador, fecha y objetivo de ese procedimiento o disparador.

• Ejemplo:  

                  /*  Procedimiento/Triger  Creado por: ing. Abraham de la barrera

                       Fecha creación: 13-06-2020

                       Objetivo: procedimiento creado para tal motivo…                              */

1. Nombre de Proyectos

• Al crear un proyecto Delphi , debes asociar el nombre de ese proyecto lo más real posible y descriptivo de la naturaleza del proyecto.

Ejemplo: un proyecto que gestione todo el proceso de un banco de sangre, obtención de muestras, pacientes y resultados de estas muestras podemos asociarlo con el nombre

Buena práctica:

• Banco_Sangre.dpr
• Banco_Sangre.exe

Mala práctica:

• Banco.dpr
• BSangre.dpr
• BancoSg
• BancoSangreMuestrasPacientesResultados

1.  Nombre de Formularios

• Los nombre de los formularios deben ir acorde a la funcionalidad de la unidad creada(Form) precedida del prefijo Frm_

Ejemplo:  Frm_Empleados

            Frm_Usuarios_Caja

1. Nombre y Naturaleza de los Datamodulos

• Los datamodulos fueron creados con el objetivo de alojar componentes no visuales  utilizados para conectividad con objetos de la base de datos.
• Todos los objetos no visuales deberian ir en datamodulos, esto evitaria duplicidad en componentes conectivos en cada uno de los formularios.
• Componentes de envios de correos, comprimidores de archivos , Lista imagenes
• Componentes de cargue y descargue de archivos

Ejemplo:   - TDataset

                    - TQuery

                    -T DbConnect

- TIdSMTP

- TimageList

-TSaveDialog  

-TOpenDialog

• El nombre de los datamodulos debe ir precedido del prefijo Dm_

Ejemplo:  Dm_Empleados

            Dm_Usuarios_Caja

1. Variables:

•  Los nombre de variables deben ir asociadas al funcionamiento de la variable, de una manera descriptiva, inicializándola con el prefijo  V_

• Las variables globales deben  inicializárse con el prefijo VG_
• Las variables  tipo parametros en funciones o procedimientos deben ser precedidas del prefijo P_

1. Constantes

•  Los nombres de las constantes deben ir asociadas al funcionamiento de esa constante, de una manera descriptiva, inicializándola con la letra C

...