En aquest tema, explorarem les millors pràctiques per escriure codi en Ada que sigui llegible, mantenible i eficient. Seguir un bon estil de codi no només facilita la col·laboració amb altres programadors, sinó que també ajuda a evitar errors i a millorar la qualitat del programari.

• Variables i Constants: Utilitza noms descriptius i significatius. Les variables han de començar amb una lletra minúscula i utilitzar el format snake_case.

  number_of_students : Integer;
  max_value : constant Integer := 100;
  

• Procediments i Funcions: Els noms de procediments i funcions han de començar amb una lletra majúscula i utilitzar el format CamelCase.

  procedure CalculateAverage is
  begin
    -- Implementació
  end CalculateAverage;
  

• Paquets: Els noms de paquets han de ser en majúscules i utilitzar el format CamelCase.

  package MathUtilities is
    -- Declaracions
  end MathUtilities;
  

• Comentaris de Línia: Utilitza comentaris de línia per explicar el propòsit del codi. Els comentaris han de ser breus i al punt.

  -- Calcula la mitjana dels valors
  procedure CalculateAverage is
  begin
    -- Implementació
  end CalculateAverage;
  

• Comentaris de Bloc: Utilitza comentaris de bloc per explicar seccions més grans de codi o lògica complexa.

  -- 
  -- Aquesta secció del codi s'encarrega de processar les dades d'entrada
  -- i generar els resultats corresponents.
  --
  procedure ProcessData is
  begin
    -- Implementació
  end ProcessData;
  

• Utilitza espais per a la indentació (recomanat 2 o 4 espais per nivell d'indentació).

  procedure ExampleProcedure is
  begin
      if condition then
          -- Codi
      else
          -- Codi
      end if;
  end ExampleProcedure;
  

• Mantingues les línies de codi curtes (màxim 80 caràcters) per millorar la llegibilitat.

  if (number_of_students > max_students) and (classroom_is_full) then
      -- Codi
  end if;
  

• Agrupa les declaracions de variables al principi del bloc de codi.

  procedure ExampleProcedure is
      number_of_students : Integer;
      max_students : constant Integer := 30;
  begin
      -- Codi
  end ExampleProcedure;
  

• Divideix el codi en subprogrames (procediments i funcions) per millorar la modularitat i la reutilització.

  procedure Main is
  begin
      Initialize;
      ProcessData;
      Finalize;
  end Main;
  

• Reutilitza codi mitjançant subprogrames i paquets per evitar la duplicació.

  procedure CalculateAverage is
  begin
      -- Implementació
  end CalculateAverage;
  
  procedure Main is
  begin
      CalculateAverage;
      -- Altres operacions
  end Main;
  

• Utilitza la gestió d'excepcions per manejar errors de manera robusta.

  procedure ReadFile is
  begin
      -- Intentar llegir un fitxer
  exception
      when others =>
          -- Manejar l'error
  end ReadFile;
  

• Documenta el codi amb comentaris i utilitza eines de documentació automàtica quan sigui possible.

  -- 
  -- Procedure CalculateAverage
  -- Calcula la mitjana dels valors d'un array.
  --
  procedure CalculateAverage is
  begin
      -- Implementació
  end CalculateAverage;
  

Refactoritza el següent codi per seguir les millors pràctiques de nomenclatura i comentaris:

Solució:

Divideix el següent codi en subprogrames per millorar la modularitat:

Solució:

Seguir un bon estil de codi i les millors pràctiques és essencial per escriure programes en Ada que siguin llegibles, mantenibles i eficients. Hem cobert aspectes clau com la nomenclatura, la estructura del codi, la modularització i la documentació. Practicar aquestes tècniques t'ajudarà a convertir-te en un programador més efectiu i a produir codi de major qualitat.