dart doc 命令
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