Code Explanation Prompt
Use this prompt to get clear, detailed explanations of complex code.
The Prompt
Please explain the following code in detail:
[paste code here]
In your explanation, include:
1. **Purpose**: What does this code accomplish?
2. **Flow**: Step-by-step walkthrough of execution
3. **Key Concepts**: Programming concepts/patterns used
4. **Dependencies**: External libraries or functions called
5. **Edge Cases**: How does it handle unusual inputs?
6. **Potential Issues**: Any bugs or improvements you notice
7. **Real-world Analogy**: Explain it like I'm not a programmer
Example Usage
Input
const debounce = (fn, delay) => {
let timeoutId;
return (...args) => {
clearTimeout(timeoutId);
timeoutId = setTimeout(() => fn(...args), delay);
};
};
Expected Output
Purpose: Creates a debounced version of a function that delays execution until after a specified time has passed since the last call.
Flow:
1. Takes a function fn and delay in milliseconds
2. Returns a new function that wraps the original
3. Each call clears any pending timeout
4. Sets a new timeout to call the original function
5. Only executes if no new calls occur within the delay period
Real-world Analogy: It's like an elevator door - it stays open when people keep entering. It only closes (executes) after no one has entered for a few seconds.
Variations
For Beginners
Add: "Explain assuming I'm new to programming"
For Experts
Add: "Focus on implementation details and performance characteristics"
For Debugging
Add: "Help me understand why this might be causing [specific issue]"