dartdoc 命令

dartdoc 命令可以从你 Dart 源代码中生成 API 参考文档。您可以使用 文档注释 向生成的文档添加说明，该说明支持 MarkDown 格式。你可以查阅 高效 Dart 的文档部分 获取更多关于如何撰写文档注释的信息。

从你 Package 的根目录中运行 dartdoc 命令。例如：

  1. $ cd my_app
  2. $ dartdoc
  3. Documenting my_app...
  4. ...
  5. Success! Docs generated into /Users/me/projects/my_app/doc/api

默认情况下，文档文件是存放在 doc/api 目录下的静态 HTML 文件。你需要一个 HTTP 服务器来查看渲染后的文档。

虽然 dartdoc 命令已存在于 Dart SDK 中，但你也可以从 dartdoc Package 找到它。你可以使用在需要编程接口或尝试 SDK 中的 dartdoc 命令没有的新功能时使用 dartdoc 的 Package。

使用 —help 命令行参数可以查看更多命令行选项：

  1. $ dartdoc --help