En aquest tema, explorarem les millors pràctiques i convencions d'estil de codi per a Groovy. Seguir aquestes directrius no només farà que el teu codi sigui més llegible i mantenible, sinó que també facilitarà la col·laboració amb altres desenvolupadors.

• Variables locals: Utilitza la notació camelCase.

  def userName = "John Doe"
  def totalAmount = 100.50
  

• Funcions: Utilitza la notació camelCase.

  def calculateTotalPrice(price, tax) {
      return price + tax
  }
  

• Classes: Utilitza la notació PascalCase.

  class UserProfile {
      String name
      int age
  }
  

• Enums: Utilitza la notació PascalCase.

  enum UserStatus {
      ACTIVE, INACTIVE, BANNED
  }
  

• Constants: Utilitza majúscules amb guions baixos.

  final int MAX_USERS = 100
  final String DEFAULT_LANGUAGE = "en"
  

• Utilitza 4 espais per a la indentació. No utilitzis tabuladors.

  class Example {
      def method() {
          if (true) {
              println "Hello, World!"
          }
      }
  }
  

• Utilitza espais en blanc per millorar la llegibilitat.

  def sum = a + b
  if (x > y) {
      println "x is greater than y"
  }
  

• Utilitza línies en blanc per separar blocs de codi lògicament relacionats.

  def initialize() {
      // Initialization code
  }
  
  def execute() {
      // Execution code
  }
  

• Utilitza comentaris de línia per explicar el codi que no és immediatament evident.

  def calculateDiscount(price) {
      // Si el preu és superior a 100, aplica un descompte del 10%
      if (price > 100) {
          return price * 0.9
      }
      return price
  }
  

• Utilitza comentaris de bloc per a explicacions més llargues o per a documentar seccions de codi.

  /*
   * Aquesta funció calcula el preu total amb impostos.
   * Paràmetres:
   * - price: El preu base del producte.
   * - tax: El percentatge d'impostos a aplicar.
   * Retorna:
   * - El preu total amb impostos.
   */
  def calculateTotalPrice(price, tax) {
      return price + (price * tax)
  }
  

• Col·loca les claus d'obertura i tancament en la mateixa línia que la condició.

  if (condition) {
      // Codi a executar si la condició és certa
  } else {
      // Codi a executar si la condició és falsa
  }
  

• Utilitza la mateixa convenció per a bucles for, while i do-while.

  for (int i = 0; i < 10; i++) {
      println i
  }
  
  while (condition) {
      // Codi a executar mentre la condició sigui certa
  }
  
  do {
      // Codi a executar almenys una vegada
  } while (condition)
  

• Mantingues les funcions curtes i enfocades en una sola tasca. Si una funció és massa llarga, considera dividir-la en funcions més petites.

• Limita el nombre de paràmetres. Si una funció necessita molts paràmetres, considera encapsular-los en un objecte.

  def createUser(String name, int age, String email) {
      // Codi per crear un usuari
  }
  

Refactoritza el següent codi per seguir les convencions d'estil de codi de Groovy:

Solució:

Crea una classe Car amb les propietats make, model i year. Afegeix un mètode displayInfo que imprimeixi la informació del cotxe.

Solució:

Seguir les convencions d'estil de codi és essencial per mantenir el codi net, llegible i fàcil de mantenir. Aquestes pràctiques no només ajuden a evitar errors, sinó que també faciliten la col·laboració amb altres desenvolupadors. En el proper tema, explorarem tècniques d'optimització del rendiment per assegurar-nos que el nostre codi Groovy sigui no només net, sinó també eficient.