dart
Комментарии

Синтаксис

• // Однострочный комментарий
• / * Многострочный / Встроенный комментарий * /
• /// Комментарий Дартдока

замечания

Комментарий к концу строки

Прокомментировано все справа от // в одной строке.

int i = 0; // Commented out text

Многострочный комментарий

Все между комментариями /* и */ .

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

Документация с использованием Dartdoc

Использование комментария doc вместо обычного комментария позволяет dartdoc находить его и генерировать документацию для него.

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

Вам разрешается использовать большинство уценки форматирования в ваш документ комментарии и dartdoc будет обрабатывать его соответствующим образом, используя пакет уценки .

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