问题背景
为AI/ML模型提供完整代码上下文时,人工收集样本常出现文件遗漏或结构混乱的情况,影响模型分析效果。
操作方案
CodeWeaver提供完整的解决方案:
- 全量收录:
- 执行
./codeweaver -ignore=""
取消默认过滤 - 检查
-included-paths-file
生成的文件确保覆盖全部路径
- 执行
- 结构保留:
- 自动生成的Markdown会保持原始目录层级
- 文件内容以代码块形式原样保留
- 版本控制:建议组合Git命令
git ls-files | xargs codeweaver
确保与版本库完全同步
最佳实践
推荐采用流水线处理:
- 用
-excluded-paths-file
记录排除项 - 对生成的codebase.md进行MD5校验
- 通过CI工具定期自动更新文档
本答案来源于文章《CodeWeaver:将代码结构和内容自动生成Markdown文档》