套件概覽
DartDoc 是一個命令列工具，可從 Dart 程式碼產生非互動式的 HTML 文件。它會解析註解與程式碼結構，產出乾淨、可瀏覽的文件，適合用於函式庫與套件。專為開發人員與維護者設計，能順暢整合至建置與發行工作流程。產生的文件包含類別、方法、屬性與相關資料，讓使用者更容易理解與使用 Dart API。支援所有主要平台，並由 Dart 團隊維護。
適用情境
- 產生庫文件
- 在 CI/CD 流水線中自動化 API 文件
- 記錄開源 Dart 套件
- 支援團隊在共用程式碼庫上的協作
- 為內部或公共API提供參考資料
主要特色
- 產生靜態 HTML 文件
- 提取並格式化 Dart 註釋
- 支援跨平台專案
- 與 pub 包管理器整合
- 產生可搜尋和可導航的輸出
適合對象
- Dart package maintainers
- Team leads managing shared code
- CI/CD pipeline integrators
- Open-source contributors
- Documentation-focused development teams
使用建議
- 需要手動格式化評論以獲得最佳結果
- 不支援互動功能，例如即時範例
- 輸出是靜態的，代碼變更後必須重新產生
- HTML 模板的自定義有限
- 開發過程中無即時預覽