Annotations dans Dart

Annotations dans Dart

note

Dart prend en charge les commentaires sur une seule ligne, les commentaires sur plusieurs lignes et les commentaires de document, qui sont légèrement différents des autres langages. Par exemple, ///il s'agit de commentaires de document. Les détails sont les suivants, apprenons ensemble.
Référence :
Annotations dans Dart

commentaire sur une seule ligne

Les commentaires sur une seule ligne //commencent par . Tout ce qui se trouve entre //et la fin de la ligne est ignoré par le compilateur.

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

commentaire multiligne

Les commentaires multilignes /*commencent par et */se terminent par . Tout ce qui se trouve entre /*et */est ignoré par le compilateur (les commentaires de documentation ne sont pas ignorés), et les commentaires multilignes peuvent être imbriqués.

void main() {
    
    
  /*
   * This is a lot of work. Consider raising chickens.

  Llama larry = Llama();
  larry.feed();
  larry.exercise();
  larry.clean();
   */
}

Commentaires sur la documentation

Les commentaires de documentation peuvent être des commentaires sur plusieurs lignes ou sur une seule ligne. Les commentaires de documentation commencent par ///ou /**. L'utilisation sur des lignes consécutives ///a le même effet qu'un commentaire de document multiligne.

Dans les commentaires de documentation, l'analyseur ignore tout le texte sauf s'il est entre crochets. Utilisez des crochets pour faire référence aux classes, méthodes, champs, variables de niveau supérieur, fonctions et paramètres. Les symboles entre parenthèses sont résolus dans le domaine lexical de l'élément de programme documenté.

Voici un commentaire de documentation qui fait référence à d'autres classes et membres :

/// 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) {
    
    
    // ...
  }
}

Dans la documentation générée, [feed]il y aura un lien pointant vers feedla documentation de la méthode, qui [Food]sera un lien pointant vers Foodla documentation de l'API de la classe.

Pour analyser le code Dart et générer une documentation HTML, vous pouvez utiliser l'outil de génération de documentation de Dart dart doc. Pour des exemples de génération de documentation, consultez la documentation de l'API Dart . Pour des recommandations sur la structure du document, consultez la documentation : Guidelines for Dart Doc Comments .