Code Explainer

A code explanation prompt that automatically detects programming languages and provides both quick summaries and detailed step-by-step breakdowns of code logic in plain English.

This prompt transforms code into accessible explanations suitable for learners at any level, including contextual notes about patterns, performance considerations, use cases, and potential issues. It adapts its output format based on code complexity, using emoji headers for larger blocks.

Prompt

# Task
Explain what the provided code does. Give a clear translation from code logic to plain English with both a quick summary and detailed breakdown.

# Instructions
- Detect the programming language automatically
- Start with language identification: "This is **[Language]** code that [high-level purpose]"
- Provide a concise summary of what the code accomplishes
- Break down the code execution step-by-step in logical order
- Add contextual notes about patterns, performance, common use cases, or potential issues
- Use clear, accessible language suitable for students and developers at any level
- Be thorough but avoid unnecessary jargon

# Output Format
State the language and general purpose in the opening line.

## Summary
One or two sentences explaining the overall result or purpose of the code.

## Details
A step-by-step breakdown of what happens when the code executes:
1. First action with context
2. Second action with context
3. Continue as needed

Include the final output or result if applicable.

## Notes
- **Pattern identification:** Name the coding pattern, idiom, or technique being used
- **Performance considerations:** Mention efficiency, optimization, or trade-offs if relevant
- **Common use cases:** Explain why someone would write code like this
- **Potential issues:** Flag any concerns, edge cases, or improvements to watch for
- **Related concepts:** Connect to similar patterns in this or other languages

For larger code blocks, organize with emoji headers:
- 📋 Summary
- 🏗️ Architecture & Flow
- ⚠️ Important Notes

# Code
````
{{str}}
````

Key Features

• Automatic Language Detection: Identifies the programming language without manual input and provides context about its purpose
• Dual-Layer Explanation:
  • Quick summary for immediate understanding
  • Detailed step-by-step breakdown following execution order
• Contextual Analysis: Goes beyond basic explanation to include:
  • Pattern and idiom identification
  • Performance and optimization trade-offs
  • Common use cases and practical applications
  • Edge cases and potential improvements
  • Related concepts and cross-language connections
• Adaptive Formatting: Uses simple headers for short snippets, emoji-organized sections (📋 Summary, 🏗️ Architecture & Flow, ⚠️ Important Notes) for larger code blocks
• Accessibility-First: Written in clear, jargon-free language appropriate for students and developers at any experience level

Technical Implementation

• Input variable: {{str}} - contains the code snippet to be explained
• Language-agnostic design: Works across all programming languages through automatic detection
• Structured output pattern:
  1. Opening line with language identification and high-level purpose
  2. Summary section with 1-2 sentence overview
  3. Details section with numbered execution steps
  4. Notes section with bulleted contextual information
• Scalable formatting: Adjusts presentation style based on code complexity
• Educational focus: Balances thoroughness with clarity, avoiding unnecessary technical jargon while maintaining accuracy