En este tema, abordaremos las mejores prácticas en la programación RPG y la importancia de la revisión de código. Estas prácticas no solo mejoran la calidad del código, sino que también facilitan su mantenimiento y escalabilidad. Además, la revisión de código es una herramienta esencial para detectar errores y mejorar la colaboración en equipo.

• Nombres Descriptivos: Utiliza nombres de variables y funciones que describan claramente su propósito.

  // Ejemplo de nombres descriptivos
  Dcl-S totalVentas Packed(10:2);
  Dcl-S nombreCliente Char(50);
  

• Comentarios: Añade comentarios para explicar partes complejas del código.

  // Calcula el total de ventas del mes
  totalVentas = ventasEnero + ventasFebrero + ventasMarzo;
  

• Indentación Consistente: Usa una indentación consistente para mejorar la legibilidad.

  If totalVentas > 10000;
     // Código para manejar ventas altas
  EndIf;
  

• Espacios y Saltos de Línea: Utiliza espacios y saltos de línea para separar lógicamente las secciones del código.

• Funciones y Procedimientos: Divide el código en funciones y procedimientos para evitar la repetición y mejorar la reutilización.

  Dcl-Proc calcularDescuento;
     Dcl-Pi *N Packed(10:2);
        totalVentas Packed(10:2);
     End-Pi;
  
     // Lógica para calcular el descuento
     Return totalVentas * 0.1;
  End-Proc;
  

• Validaciones: Realiza validaciones de entrada para evitar errores en tiempo de ejecución.

  If totalVentas < 0;
     // Manejo de error
     dsply 'Error: Total de ventas no puede ser negativo';
  EndIf;
  

• Manejo de Excepciones: Utiliza técnicas de manejo de excepciones para capturar y manejar errores inesperados.

• Documentación del Código: Documenta el propósito y el uso de las funciones y procedimientos.

  // Función para calcular el descuento basado en el total de ventas
  Dcl-Proc calcularDescuento;
     Dcl-Pi *N Packed(10:2);
        totalVentas Packed(10:2);
     End-Pi;
     // Lógica para calcular el descuento
     Return totalVentas * 0.1;
  End-Proc;
  

La revisión de código es un proceso en el que uno o más desarrolladores examinan el código escrito por otro desarrollador. Este proceso ayuda a:

• Detectar errores y bugs.
• Mejorar la calidad del código.
• Compartir conocimientos y mejores prácticas.
• Asegurar el cumplimiento de las convenciones de estilo y estándares de la empresa.

• Revisión en Pares: Dos desarrolladores revisan el código juntos, discutiendo posibles mejoras y errores.
• Revisión Formal: Un equipo de revisores examina el código y proporciona retroalimentación detallada.
• Revisión Asíncrona: Los revisores examinan el código en su propio tiempo y dejan comentarios en herramientas de control de versiones como Git.

• GitHub: Proporciona funcionalidades de pull requests y revisiones de código.
• Bitbucket: Ofrece herramientas de revisión de código integradas.
• Crucible: Una herramienta específica para la revisión de código.

• Legibilidad: ¿Es el código fácil de leer y entender?
• Funcionalidad: ¿El código cumple con los requisitos especificados?
• Eficiencia: ¿El código es eficiente en términos de rendimiento?
• Seguridad: ¿El código maneja adecuadamente los posibles problemas de seguridad?
• Mantenimiento: ¿El código es fácil de mantener y modificar?

A continuación, se presenta un fragmento de código que necesita mejoras. Aplica las mejores prácticas discutidas para mejorarlo.

Código Original

Código Mejorado

Revisa el siguiente fragmento de código y proporciona retroalimentación sobre cómo mejorarlo.

Código para Revisar

Retroalimentación

1. Nombres Descriptivos: Cambiar x, y, z por nombres más descriptivos como factorUno, factorDos, producto.
2. Comentarios: Añadir comentarios para explicar el propósito del código.
3. Documentación: Documentar el propósito de la operación de multiplicación.

En esta sección, hemos aprendido sobre las mejores prácticas en la programación RPG y la importancia de la revisión de código. Aplicar estas prácticas no solo mejora la calidad del código, sino que también facilita su mantenimiento y colaboración en equipo. La revisión de código es una herramienta esencial para detectar errores y compartir conocimientos. En el próximo módulo, aplicaremos estos conceptos en un proyecto del mundo real.