En aquest tema, explorarem les millors pràctiques per escriure codi RPG de qualitat i com realitzar una revisió de codi efectiva. Aquestes pràctiques no només ajuden a mantenir el codi net i llegible, sinó que també milloren la seva mantenibilitat i eficiència.
- Millors Pràctiques de Programació RPG
1.1. Escriure Codi Clar i Llegible
- Comentaris: Utilitza comentaris per explicar el propòsit del codi, especialment en parts complexes. No abusis dels comentaris; el codi ha de ser autoexplicatiu en la mesura del possible.
- Noms Descriptius: Utilitza noms de variables, funcions i procediments que siguin descriptius i reflecteixin el seu propòsit.
- Indentació Consistent: Mantén una indentació consistent per millorar la llegibilitat del codi.
1.2. Modularitat
- Funcions i Procediments: Divideix el codi en funcions i procediments petits i manejables. Cada funció ha de tenir una única responsabilitat.
- Reutilització de Codi: Evita la duplicació de codi reutilitzant funcions i procediments.
1.3. Gestió d'Errors
- Captura d'Errors: Implementa mecanismes per capturar i gestionar errors de manera eficient.
- Missatges d'Error: Proporciona missatges d'error clars i útils per facilitar la depuració.
1.4. Optimització del Rendiment
- Estructures de Dades Adequades: Utilitza les estructures de dades més adequades per a cada situació.
- Evitar Càlculs Innecessaris: Evita càlculs innecessaris dins de bucles o funcions crítiques de rendiment.
1.5. Documentació
- Documentació del Codi: Documenta el codi de manera adequada, incloent-hi la descripció de funcions, paràmetres i valors de retorn.
- Manuals d'Usuari: Proporciona manuals d'usuari o guies per a altres desenvolupadors que puguin treballar amb el teu codi.
- Revisió de Codi
2.1. Objectius de la Revisió de Codi
- Millorar la Qualitat del Codi: Identificar i corregir errors, millorar la llegibilitat i assegurar-se que es segueixen les millors pràctiques.
- Compartir Coneixement: Facilitar l'intercanvi de coneixements entre els membres de l'equip.
- Detectar Problemes de Seguretat: Identificar i corregir vulnerabilitats de seguretat.
2.2. Procés de Revisió de Codi
- Revisió per Parells: Un altre desenvolupador revisa el teu codi per detectar errors i suggerir millores.
- Revisió Automàtica: Utilitza eines automàtiques per analitzar el codi i detectar problemes comuns.
- Revisió en Equip: Realitza sessions de revisió en equip per discutir i millorar el codi conjuntament.
2.3. Eines per a la Revisió de Codi
- Eines de Control de Versions: Utilitza eines com Git per gestionar el codi i facilitar la revisió.
- Analitzadors de Codi Estàtic: Eines com SonarQube poden ajudar a detectar problemes de qualitat del codi de manera automàtica.
- Revisió de Codi en Línia: Plataformes com GitHub o Bitbucket permeten realitzar revisions de codi en línia de manera col·laborativa.
- Exercicis Pràctics
Exercici 1: Millora de Codi
Descripció: Millora el següent fragment de codi aplicant les millors pràctiques esmentades.
C *ENTRY PLIST
C PARM P1
C PARM P2
C PARM P3
C PARM P4
C IF P1 = 'A'
C EVAL P4 = P2 + P3
C ELSE
C EVAL P4 = P2 - P3
C ENDIF
C RETURNSolució:
// Funció per sumar o restar dos números segons el valor de P1
Dcl-Pi ProcessNumbers;
P1 Char(1);
P2 Packed(10:2);
P3 Packed(10:2);
P4 Packed(10:2);
End-Pi;
If P1 = 'A';
P4 = P2 + P3;
Else;
P4 = P2 - P3;
Endif;
Return;Exercici 2: Revisió de Codi
Descripció: Realitza una revisió de codi del següent fragment i suggereix millores.
Dcl-Pi CalculateDiscount;
Price Packed(10:2);
DiscountRate Packed(5:2);
DiscountAmount Packed(10:2);
End-Pi;
DiscountAmount = Price * DiscountRate / 100;
Return;Solució:
- Comentaris: Afegeix comentaris per explicar el propòsit de la funció.
- Noms Descriptius: Els noms són adequats, però es podria afegir més documentació.
- Gestió d'Errors: Considera afegir validacions per assegurar que els paràmetres d'entrada són vàlids.
// Funció per calcular el descompte basat en el preu i la taxa de descompte
Dcl-Pi CalculateDiscount;
Price Packed(10:2); // Preu del producte
DiscountRate Packed(5:2); // Taxa de descompte en percentatge
DiscountAmount Packed(10:2); // Import del descompte calculat
End-Pi;
// Validació dels paràmetres d'entrada
If Price < 0 Or DiscountRate < 0 Or DiscountRate > 100;
// Retorna un error o gestiona l'error adequadament
Return;
Endif;
DiscountAmount = Price * DiscountRate / 100;
Return;Conclusió
En aquesta secció, hem explorat les millors pràctiques per escriure codi RPG de qualitat i com realitzar una revisió de codi efectiva. Aplicar aquestes pràctiques ajudarà a mantenir el codi net, llegible i fàcil de mantenir, així com a detectar i corregir errors de manera eficient. A mesura que avancis en la teva carrera com a programador RPG, aquestes habilitats seran fonamentals per desenvolupar aplicacions robustes i eficients.
Curs de Programació RPG
Mòdul 1: Introducció a la Programació RPG
- Què és RPG?
- Configuració del Teu Entorn de Desenvolupament
- Sintaxi i Estructura Bàsiques
- Programa Hello World
Mòdul 2: Conceptes Bàsics
Mòdul 3: Treballant amb Dades
Mòdul 4: Tècniques Avançades de Programació
Mòdul 5: RPG IV i Més Enllà
Mòdul 6: Integrant RPG amb Tecnologies Modernes
Mòdul 7: Aplicacions del Món Real
- Construint una Aplicació Simple
- Estudi de Cas: Sistema de Gestió d'Inventari
- Estudi de Cas: Sistema de Nòmines
- Millors Pràctiques i Revisió de Codi
