En este módulo, aprenderemos sobre las mejores prácticas para mantener un código limpio, legible y mantenible en Dart. Seguir un estilo de código consistente no solo facilita la colaboración en equipo, sino que también ayuda a evitar errores y a mejorar la eficiencia del desarrollo.

  1. Importancia del Estilo de Código

Un estilo de código consistente:

  • Mejora la legibilidad: Facilita la comprensión del código por parte de otros desarrolladores.
  • Facilita el mantenimiento: Hace que el código sea más fácil de actualizar y depurar.
  • Promueve buenas prácticas: Ayuda a evitar errores comunes y a seguir patrones de diseño recomendados.

  1. Guía de Estilo de Dart

Dart tiene una guía de estilo oficial que se puede encontrar en Effective Dart. A continuación, se presentan algunos de los puntos más importantes.

2.1. Nombres de Identificadores

  • Clases y Enum: Usar UpperCamelCase.

    class MyClass {}
    enum Color { red, green, blue }
    
  • Variables, funciones y parámetros: Usar lowerCamelCase.

    var myVariable;
    void myFunction() {}
    
  • Constantes: Usar lowerCamelCase o UPPER_SNAKE_CASE.

    const pi = 3.14;
    const MAX_SIZE = 100;
    

2.2. Espacios y Sangrías

  • Usar 2 espacios para la sangría.

    void main() {
      if (true) {
        print('Hello, Dart!');
      }
    }
    
  • No usar tabulaciones.

2.3. Longitud de Línea

  • Mantener las líneas de código por debajo de 80 caracteres.
    // Correcto
    var myString = 'This is a string that is less than 80 characters long.';
    
    // Incorrecto
    var myString = 'This is a string that is way too long and exceeds the 80 characters limit, which is not recommended.';
    

2.4. Uso de Llaves

  • Siempre usar llaves {} para bloques de código, incluso si contienen una sola línea.
    // Correcto
    if (condition) {
      doSomething();
    }
    
    // Incorrecto
    if (condition)
      doSomething();
    

2.5. Espacios en Blanco

  • Usar espacios en blanco para mejorar la legibilidad.
    // Correcto
    var sum = a + b;
    
    // Incorrecto
    var sum=a+b;
    

2.6. Comentarios

  • Usar comentarios para explicar el "por qué" del código, no el "qué".
    // Correcto
    // Calculate the area of a circle.
    double area = pi * radius * radius;
    
    // Incorrecto
    // Multiply pi by radius squared.
    double area = pi * radius * radius;
    

  1. Herramientas de Formateo

3.1. Dartfmt

Dart proporciona una herramienta de formateo automática llamada dartfmt. Esta herramienta puede formatear tu código según las convenciones de estilo de Dart.

  • Instalación y uso:
    dart format .
    

3.2. Análisis Estático

El analizador de Dart (dart analyze) puede ayudarte a encontrar problemas en tu código y a asegurarte de que sigues las mejores prácticas.

  • Instalación y uso:
    dart analyze
    

  1. Ejercicio Práctico

Ejercicio 1: Formateo de Código

Dado el siguiente fragmento de código, formatearlo según las convenciones de estilo de Dart.

class person{String name; int age; person(this.name,this.age);}

void main(){var p=person('Alice',30);print('Name: ${p.name}, Age: ${p.age}');}

Solución

class Person {
  String name;
  int age;

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

void main() {
  var p = Person('Alice', 30);
  print('Name: ${p.name}, Age: ${p.age}');
}

Conclusión

En esta sección, hemos aprendido la importancia de seguir un estilo de código consistente y las principales convenciones de estilo en Dart. También hemos visto cómo usar herramientas como dartfmt y dart analyze para mantener nuestro código limpio y libre de errores. Siguiendo estas prácticas, podemos escribir código más legible, mantenible y profesional.

© Copyright 2024. Todos los derechos reservados