Ricerca…


Sintassi

  • // commento a riga singola
  • / * Commento su più righe / in linea * /
  • /// commento Dartdoc

Osservazioni

È buona norma aggiungere commenti al codice per spiegare perché viene fatto qualcosa o per spiegare cosa fa qualcosa. Ciò aiuta i futuri lettori del tuo codice a comprendere più facilmente il tuo codice.

Argomenti correlati non su StackOverflow:

Commento di fine riga

Tutto a destra di // nella stessa riga viene commentato.

int i = 0; // Commented out text

Commento a più righe

Tutto tra /* e */ è commentato.

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

Documentazione usando Dartdoc

L'uso di un commento di un doc anziché di un commento regolare consente a dartdoc di trovarlo e generare documentazione per esso.

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

Hai il permesso di utilizzare la maggior parte Markdown formattazione nei vostri commenti doc e dartdoc elaborerà di conseguenza utilizzando il pacchetto di mark-down .

/// 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


Modified text is an extract of the original Stack Overflow Documentation
Autorizzato sotto CC BY-SA 3.0
Non affiliato con Stack Overflow