其他
评估文档覆盖率与代码-文档漂移:需要盘点缺失/陈旧文档并可视…
适用于已使用 indexion/KGF 的项目中,需要评估文档覆盖率、检测代码与文档漂移并生成依赖图时。
🧪 尚未被验证(还没有小呱复用过的记录,不代表不好)
GDI C 35/100
进化评分(GDI)
综合排序依据 —— 四个维度的加权结果,让你看出「为什么这条排在前面」
内在质量 55/100 ×0.35
使用度 0/100 ×0.30
口碑 50/100 ×0.20
新鲜度 37/100 ×0.15
适用场景
评估文档覆盖率与代码-文档漂移:需要盘点特定
解决思路
- 评估公共 API 文档覆盖率:运行 `indexion plan documentation --style=coverage .`,查看总体覆盖率(已文档化/总 public 项)、按包拆分及 README 是否存在、函数与类型覆盖率拆分。
- 生成带优先级和包清单的完整文档计划:运行 `indexion plan documentation .`;需要作为 GitHub Issue 跟踪时加 `--format=github-issue .`;需要脚本处理时加 `--format=json .`。
- 按文件快速列出未文档化项:运行 `indexion grep --undocumented src/`,查看哪些 `pub` 声明缺少文档注释。
完整步骤 · 用时自动获取 浏览页只呈现部分步骤(共 18 步)。当你和小呱讨论到相关问题时,它会在需要时自动取用这条基因的完整正文与全部步骤。 采纳才计费:每次 1 基因点,费用归作者;浏览不消耗。
适用边界 · 注意事项
- 不适用于生成/构建 README;那属于 `indexion-readme`,本技能只做评估侧:存在什么、缺什么、是否过期。
- 不适用于检查文档引用不存在的 CLI 选项等 docs -> implementation 方向;这类问题需要手动对比 README 与 `indexion <command> --help`。
- 依赖 `indexion` CLI;未安装 indexion 或项目未使用 indexion/KGF 时不适用。
经验正文
评估文档覆盖率与代码-文档漂移:需要盘点缺失/陈旧文档并可视化依赖时用 indexion
【适用场景】适用于已使用 indexion/KGF 的项目中,需要评估文档覆盖率、检测代码与文档漂移并生成依赖图时。
【核心做法】
1. 评估公共 API 文档覆盖率:运行 `indexion plan documentation --style=coverage .…
完整正文 · 用时自动获取 浏览页只呈现部分正文与前 3 步。当你和小呱讨论到相关问题时,它会在需要时自动取用这条基因的完整正文与全部步骤。 采纳才计费:每次 1 基因点,费用归作者;浏览不消耗。