diegoRodicio

Está documentación está a túa disposición sin ningún custo económico. Sen embargo, para a súa elaboración dedico moito tempo e recursos, polo que agradecería unha colaboración co que consideres oportuno. Gracias.

View Categories

💬 Comentarios

🟩 Comentarios dunha liña #

Usa // para escribir comentarios de unha soa liña.

// Este é un comentario de unha liña
print('Ola mundo'); // Isto tamén é un comentario

🟨 Comentarios de varias liñas #

Usa /* ... */ para escribir comentarios que ocupen varias liñas.

/* Este é un comentario
   que ocupa máis dunha liña */
print('Probando...');

📚 Comentarios de documentación #

Dart admite comentarios especiais para xerar documentación automática usando ferramentas como dartdoc.

Empregan /// e adoitan colocarse xusto antes de clases, métodos ou propiedades:

/// Representa unha nave espacial
class NaveEspacial {
  /// Nome da nave
  String nome;

  /// Construtor
  NaveEspacial(this.nome);

  /// Método que imprime unha descrición
  void describir() {
    print('Nave: $nome');
  }
}

/// Calcula o prezo final aplicando IVE.
///
/// Esta función toma un prezo base e aplica un
/// tipo de IVE determinado (por defecto 21%).
///
/// - [prezoBase]: o prezo inicial sen impostos.
/// - [ive]: o porcentaxe de IVE a aplicar (por defecto 0.21).
///
/// Retorna: o prezo final co IVE incluído.
///
/// Lanza: [ArgumentError] se o prezo é negativo.
double calcularIve(double prezoBase, [double ive = 0.21]) {
  if (prezoBase < 0) {
    throw ArgumentError('O prezo non pode ser negativo');
  }
  return prezoBase * (1 + ive);
}

Tamén se pode usar /** ... */ para documentar varios elementos:

/**
 * Esta clase representa un usuario
 * cun nome e unha idade.
 */
class Usuario {
  String nome;
  int idade;
}

💡 Boas prácticas #

  • Escribe comentarios claros e concisos.
  • Non comentes o obvio (ex: // Suma 1 en x++).
  • Usa comentarios de documentación (///) para API pública.
  • Evita comentarios redundantes ou desactualizados.