开工之后大家是不是去年的代码忘的差不多了?坐在工位上忘了自己是做什么工作的,又或者同事跑路接手了烂摊子等等,导致现在看到之前的代码两眼一黑。
所以我做了一个快速阅读小工具
维护代码时候的痛点
在维护老项目时,我们可能都遇到过:
- 前任带着他的小黄鸭跑路,历史代码缺少文档,核心逻辑难以追溯
- 祖传方法,发现注释比代码还难懂
- 新人熟悉代码成本高,容易陷入细节迷宫
- 想重构却不知从何下手,担心破坏隐藏逻辑
- 给同事 codeview 但是看着费劲
核心功能
利于 LLM+适当的提示词生成代码文档,快速查看代码,例如代码梳理,漏洞检查等。
使用示例
-
正常用法(代码梳理)
-
趣味玩法(暴躁猫娘)
-
其他提示词
使用场景建议
- 接手新项目时快速建立代码地图
- 评审他人代码前获取概要理解
- 为历史代码添加过渡性文档
- 教学场景中的代码案例解析
项目地址
- 目前还在测试阶段,可能有很多未知的 bug
- 提示词模板大多由 DeepSeek 生成,大多我也没有测试,只是希望给大家一些奇奇怪怪的灵感。具体还是需要根据自己使用模型和代码实际情况进行调整。
- 地址: https://github.com/woniu9524/CodeAsk