Suche…


Syntax

  • // Einzeiliger Kommentar
  • / * Mehrzeilig / Inline-Kommentar * /
  • /// Dartdoc-Kommentar

Bemerkungen

Es ist empfehlenswert, Ihrem Code Kommentare hinzuzufügen, um zu erklären, warum etwas getan wird, oder um zu erklären, was etwas tut. Dies hilft zukünftigen Lesern Ihres Codes, Ihren Code leichter zu verstehen.

Verwandte Themen nicht bei StackOverflow:

Kommentar zum Zeilenende

Alles rechts von // in derselben Zeile wird kommentiert.

int i = 0; // Commented out text

Mehrzeiliger Kommentar

Alles zwischen /* und */ ist kommentiert.

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

Dokumentation mit Dartdoc

Wenn Sie einen Dokumentenkommentar anstelle eines regulären Kommentars verwenden, kann dartdoc diesen finden und eine Dokumentation dafür erstellen .

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

Sie können die meisten Markdown- Formatierungen in Ihren Doc-Kommentaren verwenden. Dartdoc verarbeitet sie entsprechend mit dem Markdown-Paket .

/// 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
Lizenziert unter CC BY-SA 3.0
Nicht angeschlossen an Stack Overflow