案例八:代码笔记助手
记录代码相关笔记时,AI 帮助解释代码、生成文档、分析错误。
功能矩阵
| 功能 | 用途 | Prompt 示例 |
|---|---|---|
| 代码解释 | 理解复杂代码 | "解释这段代码的逻辑" |
| 文档生成 | 生成函数文档 | "生成 JSDoc 注释" |
| 错误分析 | 排查问题 | "分析这个错误的原因" |
| 代码重构 | 优化代码 | "重构这段代码使其更清晰" |
| 测试生成 | 生成测试用例 | "为这个函数生成测试" |
代码笔记模板
markdown
---
title: {{code_topic}}
language: {{language}}
tags: [code, {{language}}]
---
# {{code_topic}}
## 📝 问题描述
<!-- 遇到的问题或学习目标 -->
## 💻 代码
## 🤖 AI 解释
<!-- AI 生成的代码解释 -->
## 💡 我的理解
<!-- 个人理解 -->
## 🔗 相关资源
- [[]]代码解释 Prompt
markdown
# 代码解释
## 代码
```{{language}}
{{code}}解释要求
输出格式
概述
[一句话说明代码的作用]
详细解释
[逐行或逐块解释]
关键点
- 要点1
- 要点2
时间复杂度
[分析]
空间复杂度
[分析]
改进建议
- 建议1
- 建议2
相关概念
- 概念1:解释
- 概念2:解释
## 错误分析 Prompt
```markdown
# 错误分析
## 代码
## 错误信息
## 分析要求
1. 错误原因分析
2. 可能的解决方案(按优先级)
3. 最佳实践建议
4. 预防措施