用途
code-sample-checker 面向文档集合中的代码示例质量检查,旨在查找并检查文档中的每一个代码示例,使读者和智能体复制出去的示例能够正常工作。
状态
当前仅为脚手架(Scaffold only),尚未可供使用。
计划能力
- 提取带语言标签的围栏代码块及其上下文
- 按示例所用语言进行 lint 或解析,并标记缺少语言标签的代码块
- 标记已废弃的 API、过时的包版本,以及未加说明的占位值
- 在用户允许时,于沙箱中运行安全、自包含的示例
- 检查不同语言中的等价示例是否执行相同的操作
使用方式
资料未提供安装命令、调用方式或配置说明。
适用场景
适用于需要批量核查文档代码示例的一致性、语法有效性与 API/版本时效性的文档维护场景。
限制
工具尚未就绪,无法实际使用;具体实现细节、平台支持与使用步骤暂未提供。