dart
commentaires

Syntaxe

• // Commentaire sur une seule ligne
• / * Multi-line / In-line comment * /
• /// Commentaire Dartdoc

Remarques

Commentaire de fin de ligne

Tout à droite de // dans la même ligne est commenté.

int i = 0; // Commented out text

Commentaire multi-lignes

Tout entre /* et */ est commenté.

void main() {
  for (int i = 0; i < 5; i++) {
    /* This is commented, and
    will not affect code */
    print('hello ${i + 1}');
  }   
}

Documentation utilisant Dartdoc

L'utilisation d'un commentaire doc au lieu d'un commentaire régulier permet à dartdoc de le trouver et de générer la documentation correspondante.

/// The number of characters in this chunk when unsplit.
int get length => ...

Vous êtes autorisé à utiliser la plupart des formats de démarques dans vos commentaires doc et dartdoc les traitera en conséquence en utilisant le package markdown .

/// This is a paragraph of regular text.
///
/// This sentence has *two* _emphasized_ words (i.e. italics) and **two**
/// __strong__ ones (bold).
///
/// A blank line creates another separate paragraph. It has some `inline code`
/// delimited using backticks.
///
/// * Unordered lists.
/// * Look like ASCII bullet lists.
/// * You can also use `-` or `+`.
///
/// Links can be:
///
/// * http://www.just-a-bare-url.com
/// * [with the URL inline](http://google.com)
/// * [or separated out][ref link]
///
/// [ref link]: http://google.com
///
/// # A Header
///
/// ## A subheader