Overview
This prompt aims to enhance code readability by adding simple comments for beginner developers. Newcomers to programming will benefit from clear explanations that make understanding the code easier.
Prompt Overview
Purpose: This task aims to make programming code understandable for beginners by adding simple comments.
Audience: The intended audience includes beginner developers, particularly those in middle school or early high school.
Distinctive Feature: The comments are written at a 7th-grade reading level, ensuring clarity and accessibility.
Outcome: Readers will learn the purpose and functionality of the code, making it easier to follow and modify.
Quick Specs
- Media: Text
- Use case: Generation
- Industry: Content & Media Creation, Property Development
- Techniques: Few-Shot Prompting, Self-Critique / Reflection, Structured Output
- Models: Claude 3.5 Sonnet, Gemini 2.0 Flash, GPT-4o, Llama 3.1 70B
- Estimated time: 5-10 minutes
- Skill level: Beginner
Variables to Fill
No inputs required — just copy and use the prompt.
Example Variables Block
No example values needed for this prompt.
The Prompt
Add clear and simple comments throughout the entire code in the provided file.
Ensure the comments are written at a 7th-grade reading level, so that even beginner developers can easily understand:
– The purpose and functionality of each section
– Each function, variable, and class
Explain how each part works, why it is there, and provide guidance on how to proceed with the code.
Use straightforward language, avoid technical jargon, and ensure the comments make the code approachable and educational for newcomers.
# Steps
– Go through the code file section by section.
– For each class:
– Explain what the class represents and its role.
– For each function:
– Describe what it does
– Outline its inputs and outputs
– Highlight any important logic inside.
– For variables:
– Explain what they store and why they are needed.
– Add comments before or within code blocks to clarify their purpose and how they work.
– Keep the language simple, concise, and suitable for 7th graders.
# Output Format
Return the complete code with your added comments included inline, maintaining the original code structure and formatting.
The commented code should be fully readable and educational for beginners to understand how it works and how to continue working with it.
Screenshot Examples
How to Use This Prompt
- Copy the prompt provided above.
- Open the code file you want to comment on.
- Paste the prompt into your coding environment.
- Follow the steps outlined in the prompt to add comments.
- Ensure comments are clear and at a 7th-grade reading level.
- Review the commented code for clarity and educational value.
Tips for Best Results
- Use Clear Comments: Write comments that explain what each part of the code does, using simple language.
- Explain Functions: Describe what each function does, what it needs to work, and what it gives back.
- Clarify Variables: State what each variable is for and why it is important in the code.
- Keep It Simple: Use easy words and short sentences so that beginners can easily understand the code.
FAQ
- What is the purpose of adding comments in code?
Comments help explain what the code does, making it easier for beginners to understand. - How should comments be written for beginners?
Use simple language and avoid technical terms, aiming for a 7th-grade reading level. - What should be explained in each class comment?
Describe what the class represents and its role in the overall program. - What details should be included for functions?
Explain what the function does, its inputs and outputs, and any important logic.
Compliance and Best Practices
- Best Practice: Review AI output for accuracy and relevance before use.
- Privacy: Avoid sharing personal, financial, or confidential data in prompts.
- Platform Policy: Your use of AI tools must comply with their terms and your local laws.
Revision History
- Version 1.0 (February 2026): Initial release.
