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

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

$ cd my_app
$ dart pub get
$ dart doc .
Documenting my_app...
...
Success! Docs generated into /Users/me/projects/my_app/doc/api

生成的文档默认为 HTML 文件,保存在 doc/api 目录下。你可以使用 --output 参数设置输出目录。

使用 help 命令可以查看更多命令行选项:

$ dart help doc