AgentLens - 代码库导航
处理任何代码库之前
务必先阅读.agentlens/INDEX.md以获取项目地图。
导航层级
| 层级 | 文件 | 用途 |
|---|---|---|
| L0 | INDEX.md | 项目概览，列出所有模块 |
| L1 | modules/{slug}/MODULE.md | 模块详情，文件列表 |
| L1 | modules/{slug}/outline.md | 大型文件中的符号 |
| L1 | modules/{slug}/memory.md | 待办事项、警告、业务规则 |
| L1 | modules/{slug}/imports.md | 文件依赖关系 |
| L2 | files/{slug}.md | 复杂文件的深度文档 |
导航流程
INDEX.md → Find module → MODULE.md → outline.md/memory.md → Source file
何时阅读什么
| 你的需求 | 阅读此文档 |
|---|---|
| 项目概览 | .agentlens/INDEX.md |
| 查找模块 | INDEX.md，搜索模块名称 |
| 理解模块 | modules/{slug}/MODULE.md |
| 在大文件中查找函数/类 | modules/{slug}/outline.md |
| 查找待办事项、警告、规则 | modules/{slug}/memory.md |
| 理解文件依赖关系 | modules/{slug}/imports.md |
最佳实践
- 不要直接阅读源文件对于大型代码库 - 先使用 outline.md
- 在修改代码前检查 memory.md以查看警告和待办事项
- 使用outline.md定位符号然后仅读取所需的源代码部分
- 重新生成文档使用
agentlens命令（如果文档看起来已过时）
详细导航模式请参见references/navigation.md结构说明请参见references/structure.md
微信扫一扫，打赏作者吧～
网友评论
最新评论