使用 Dartdoc 的文件

使用 doc 註釋而不是常規註釋使 dartdoc 能夠找到它併為其生成文件。

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

你可以在文件註釋中使用大多數降價格式，dartdoc 將使用 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