dart 使用Dartdoc的文档

示例

使用文档注释而不是常规注释使dartdoc可以找到它并为其生成文档。

///未拆分时此块中的字符数。
int get length => ...

您可以在文档注释中使用大多数markdown格式,而dartdoc会使用markdown包对其进行相应的处理。

///这是一段常规文本。
///
///这句话有*两个*强调的单词(即斜体)和**两个**
/// __strong__个(粗体)。
///
///空白行将创建另一个单独的段落。它有一些“内联代码”
///使用反引号分隔。
///
/// *无序列表。
/// *看起来像ASCII项目符号列表。
/// *您也可以使用`-`或`+`。
///
///链接可以是:
///
/// * http://www.just-a-bare-url.com
/// * [with the URL inline](http://google.com)
/// * [或分开] [参考链接]
///
/// [ref link]: http://google.com
///
///#标题
///
/// ##一个子标题