Comentários

Dart suporta comentários de linha única, comentários multi-linha e comentários de documentação.

Um comentário de linha única começa com //. Tudo entre // e o final da linha é ignorado pelo compilador Dart.

void main() {
  // TODO: refactor into an AbstractLlamaGreetingFactory?
  print('Welcome to my Llama farm!');
}

Um comentário multi-linha começa com /* e termina com */. Tudo entre /* e */ é ignorado pelo compilador Dart (a menos que o comentário seja um comentário de documentação; veja a próxima seção). Comentários multi-linha podem ser aninhados.

void main() {
  /*
   * This is a lot of work. Consider raising chickens.
​
  Llama larry = Llama();
  larry.feed();
  larry.exercise();
  larry.clean();
   */
}

Comentários de documentação são comentários multi-linha ou de linha única que começam com /// ou /**. Usar /// em linhas consecutivas tem o mesmo efeito que um comentário de documentação multi-linha.

Dentro de um comentário de documentação, o analyzer ignora todo o texto a menos que esteja entre colchetes. Usando colchetes, você pode se referir a classes, métodos, campos, variáveis de nível superior, funções e parâmetros. Os nomes entre colchetes são resolvidos no escopo léxico do elemento de programa documentado.

Aqui está um exemplo de comentários de documentação com referências a outras classes e argumentos:

/// A domesticated South American camelid (Lama glama).
///
/// Andean cultures have used llamas as meat and pack
/// animals since pre-Hispanic times.
///
/// Just like any other animal, llamas need to eat,
/// so don't forget to [feed] them some [Food].
class Llama {
  String? name;
​
  /// Feeds your llama [food].
  ///
  /// The typical llama eats one bale of hay per week.
  void feed(Food food) {
    // ...
  }
​
  /// Exercises your llama with an [activity] for
  /// [timeLimit] minutes.
  void exercise(Activity activity, int timeLimit) {
    // ...
  }
}

Na documentação gerada da classe, [feed] se torna um link para a documentação do método feed, e [Food] se torna um link para a documentação da classe Food.

Para analisar código Dart e gerar documentação HTML, você pode usar a ferramenta de geração de documentação do Dart, dart doc. Para um exemplo de documentação gerada, veja a documentação da API Dart. Para conselhos sobre como estruturar seus comentários, veja Effective Dart: Documentation.