SuperAPI AI 工具集

dart-doc-validation

写作与研究

查看项目

更新于 10-15 21:43

技能介绍

用途:在编写或更新 Dart 代码中的文档注释(///)时,检查损坏的文档链接、引用或宏,并可在发布到 pub.dev 前做校验。

主要能力:发现文档问题,包括检查 comment_references lint 是否启用(在 analysis_options.yaml 中搜索 comment_references),以及运行文档生成器暴露警告,关注 warning:、unresolved doc reference、undefined macro 等关键词。

使用方式:在 analysis_options.yaml 中启用 lint:

linter: rules: - comment_references

本地校验文档时,用临时输出目录运行,避免污染项目工作区:

dart doc -o $(mktemp -d)

该命令适用于 Mac 和 Linux,会解析所有文档注释并报告警告,如 warning: unresolved doc reference、warning: undefined macro。若要在本地浏览生成的文档,可安装 dhttpd:

pub global activate dhttpd TMP_DIR=$(mktemp -d) && dart doc -o "$TMP_DIR" && dhttpd --path "$TMP_DIR"

也可使用其他 HTTP 服务器,例如 python3 -m http.server。

修复常见警告:未解析的文档引用需确保方括号中的标识符([Identifier])正确指向当前作用域或已导入库中存在的类、方法、属性或参数;未定义宏若使用 {@macro macro_name},需确保模板 {@template macro_name} 定义在同一文件或文档生成器可见的已导入文件中。

适用场景:编写或更新 Dart 文档注释、检查文档链接与宏、发布包前准备。

限制:资料未提供更多平台支持、收费或效果信息。