Introducció

En aquest tema, aprendrem sobre les millors pràctiques per escriure codi Dart net, llegible i mantenible. Seguir un estil de codi consistent no només fa que el teu codi sigui més fàcil de llegir i entendre, sinó que també facilita la col·laboració amb altres desenvolupadors. Dart té un conjunt de guies d'estil recomanades que anomenem "Effective Dart". Explorarem aquestes guies i veurem com aplicar-les en els nostres projectes.

  1. Nomenclatura

1.1. Variables i Funcions

  • Variables: Utilitza el format camelCase per a les variables.

    int userAge = 25;
    String userName = 'John Doe';
    
  • Funcions: També utilitza camelCase per a les funcions.

    void printUserName(String name) {
      print(name);
    }
    

1.2. Classes i Enums

  • Classes: Utilitza el format PascalCase per a les classes.

    class UserProfile {
      String name;
      int age;
    
      UserProfile(this.name, this.age);
    }
    
  • Enums: També utilitza PascalCase per als enums.

    enum UserRole {
      Admin,
      User,
      Guest
    }
    

1.3. Constants

  • Constants: Utilitza camelCase per a les constants, però amb la paraula clau const.
    const int maxUsers = 100;
    const String appName = 'MyApp';
    

  1. Indentació i Espais

2.1. Indentació

  • Utilitza 2 espais per a la indentació. No utilitzis tabuladors.
    void main() {
      if (true) {
        print('Hello, World!');
      }
    }
    

2.2. Espais

  • Deixa un espai després de les comes i els punts i comes.

    void main() {
      print('Hello, World!');
    }
    
  • Deixa un espai abans i després dels operadors.

    int sum = 5 + 3;
    

  1. Comentaris

3.1. Comentaris de Línia

  • Utilitza // per a comentaris de línia.
    // Això és un comentari de línia
    int sum = 5 + 3; // Suma de dos números
    

3.2. Comentaris de Bloc

  • Utilitza /* ... */ per a comentaris de bloc.
    /*
     * Això és un comentari de bloc.
     * Pot ocupar múltiples línies.
     */
    int sum = 5 + 3;
    

3.3. Comentaris de Documentació

  • Utilitza /// per a comentaris de documentació.
    /// Aquesta funció imprimeix el nom de l'usuari.
    ///
    /// [name] és el nom de l'usuari.
    void printUserName(String name) {
      print(name);
    }
    

  1. Estructura del Codi

4.1. Importacions

  • Organitza les importacions en tres blocs: importacions de paquets del sistema, importacions de paquets de tercers i importacions locals. Separa cada bloc amb una línia en blanc.
    import 'dart:math';
    
    import 'package:flutter/material.dart';
    
    import 'src/my_widget.dart';
    

4.2. Línies en Blanc

  • Utilitza línies en blanc per separar blocs de codi lògicament relacionats.
    void main() {
      var user = UserProfile('John Doe', 25);
    
      printUserName(user.name);
    }
    
    void printUserName(String name) {
      print(name);
    }
    

  1. Exercicis Pràctics

Exercici 1: Nomenclatura

Refactoritza el següent codi per seguir les guies de nomenclatura de Dart:

class userprofile {
  String Name;
  int Age;

  userprofile(this.Name, this.Age);
}

void PrintUserName(String Name) {
  print(Name);
}

Solució:

class UserProfile {
  String name;
  int age;

  UserProfile(this.name, this.age);
}

void printUserName(String name) {
  print(name);
}

Exercici 2: Indentació i Espais

Refactoritza el següent codi per seguir les guies d'indentació i espais de Dart:

void main(){
if(true){
print('Hello, World!');
}
}

Solució:

void main() {
  if (true) {
    print('Hello, World!');
  }
}

Conclusió

Seguir un estil de codi consistent és essencial per mantenir el teu codi net, llegible i fàcil de mantenir. En aquest tema, hem après les guies d'estil recomanades per Dart, incloent-hi la nomenclatura, la indentació, els espais, els comentaris i l'estructura del codi. Practica aquestes guies en els teus projectes per millorar la qualitat del teu codi i facilitar la col·laboració amb altres desenvolupadors.

© Copyright 2024. Tots els drets reservats