用途:分析文档覆盖率,找出缺少文档的公开 API,并生成可执行的文档计划,适合发布前检查、文档冲刺规划,以及新增公开 API 后验证覆盖情况。
主要能力:支持完整计划(full)与快速覆盖概览(coverage)两种输出风格;输出格式支持 Markdown、JSON 和 GitHub Issue;可套用 GitHub Issue Form 模板,可设置项目名,可写入文件。公开项检测基于 KGF 分词,识别 pub、public、export 等可见性关键字及其后的 fn、struct、class、enum、type、trait 等声明,并关联前置的 /// 文档注释,会跳过 _test.mbt、_wbtest.mbt 等测试文件。
使用方式:基础命令为 indexion plan documentation <path>。快速覆盖概览:indexion plan documentation --style=coverage 。GitHub Issue 格式:indexion plan documentation --format=github-issue 。JSON 输出:indexion plan documentation --format=json 。指定模板:indexion plan documentation --template=.github/ISSUE_TEMPLATE/doc.yml 。指定名称:indexion plan documentation --name= 。输出到文件:indexion plan documentation -o=doc-plan.md 。常用选项还包括 --specs-dir(默认 kgfs)等。
适用场景:快速检查未文档化项可用 indexion grep --undocumented src/;发布用覆盖报告可用 plan documentation --style=coverage .;完整优先级计划用 plan documentation .;在 GitHub Issues 中跟踪用 plan documentation --format=github-issue .。
限制与注意:资料显示 --style=coverage 在 750+ 文件代码库上约 8 秒完成,若卡住需检查是否包含测试文件;覆盖率为百分比统计,仅含 ///| 标记而无描述文本的注释也算已文档化,需查看 doc_preview 列判断质量;具体语言支持取决于是否存在对应 KGF 规范,资料未提供完整语言列表。