Add Beginner-Friendly Comments
Prompt
Add clear and simple comments throughout the entire code in the provided file. Make sure 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, 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, its inputs and outputs, and 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.
Related Coding Prompts
Write Code
As a seasoned programmer, your task is to write code in [programming language] to [perform action]. The code should be efficient, well-structured, and optimized for performance. Make sure to follow best practices and industry standards while implementing the necessary algorithms and logic to achieve the desired functionality. Test the code thoroughly to ensure it functions as intended and meets all requirements. Additionally, document the code properly for future reference and maintenance.
Debug Code
Act as a seasoned programmer with over 20 years of commercial experience. Analyze the provided [piece of code] that is causing a specific [error]. Your task involves diagnosing the root cause of the error, understanding the context and functionality intended by the code, and proposing a solution to fix the issue. Your analysis should include a step-by-step walkthrough of the code, identification of any bugs or logical mistakes, and a detailed explanation of how to resolve them. Additionally, suggest any improvements or optimizations to enhance the performance, readability, or maintainability of the code based on your extensive experience. Ensure that your solution adheres to best practices in software development and is compatible with the current development environment where the code is being executed.
Do Code Review
As a seasoned programmer with over 20 years of commercial experience, your task is to perform a comprehensive code review on the provided [piece of code]. Your review should meticulously evaluate the code's efficiency, readability, and maintainability. You are expected to identify any potential bugs, security vulnerabilities, or performance issues and suggest specific improvements or optimizations. Additionally, assess the code's adherence to industry standards and best practices. Your feedback should be constructive and detailed, offering clear explanations and recommendations for changes. Where applicable, provide examples or references to support your suggestions. Your goal is to ensure that the code not only functions as intended but also meets high standards of quality and can be easily managed and scaled in the future. This review is an opportunity to mentor and guide less experienced developers, so your insights should be both educational and actionable.