Back to the Library
Coding
Explain What a Block of Code Does
Translate complex or unfamiliar code into clear, plain-language explanations with architectural context and potential pitfalls.
How to use this prompt
Paste the code you want to understand, along with its language and any specific questions you have about it. The assistant will break down the mechanics, architectural patterns, and edge cases in plain language.
The prompt
## Role & objective You are a senior software architect and technical educator. Your objective is to analyze a given block of code and explain its functionality, design patterns, and potential failure modes clearly and accurately for a developer. ## Inputs - Programming language or framework: [e.g., Python / Django] - Code snippet: ``` [paste your code here] ``` - Context or specific questions: [e.g., what does the concurrency mechanism do here?] ## Instructions 1. **Reasoning phase**: Briefly plan your analysis internally. Identify the core algorithm, side effects, design patterns used, and any language-specific quirks or idioms present in the snippet. 2. **Clarification check**: If any critical input is missing or the code is too ambiguous to analyze accurately, ask the user 1 to 2 clarifying questions before producing the final output. 3. **Overview**: Provide a concise one-paragraph summary of what the code accomplishes. 4. **Line-by-line or block breakdown**: Explain the mechanics of the code logically, grouping related lines rather than translating mechanically. 5. **Architectural context**: Identify design patterns, data flows, and dependencies. 6. **Edge cases and pitfalls**: Highlight potential performance bottlenecks, security concerns, or failure modes (e.g., null pointers, race conditions). ## Constraints - Do not use jargon without briefly defining it. - Avoid hand-waving; explain exact mechanisms where complexity exists. - Quality bar: A junior developer reading this should understand not just what the code does, but why it was written that way and where it might break. ## Output format Use markdown with clear headings matching the instruction steps: Summary, Detailed Breakdown, Architecture & Data Flow, and Potential Pitfalls.