插件概览
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 模板的自定义有限
- 开发过程中无实时预览