Quia - Class Page - 1.6 Commenting Code -Python with Karel

1

Why Leave Notes?

🧱Real-Life Connection

Imagine you and your friend are building an awesome LEGO tower together. You're halfway through, and the tower is getting really tall and complicated! But suddenly, you have to leave for soccer practice.

💭 Think About It: What kind of notes or directions would help your friend finish the tower correctly without you there?

Share Your Ideas:

⏰ Discussion Time: 5 minutes

💡Connection to Coding:

Programmers do the same thing when they use comments in their code! Comments are like leaving helpful notes in your program so that you (and others) can understand what each part does—even weeks or months later!

2

Objective & Agenda

🎯Today's Objective:

I can apply comments in Python so others — and I myself — can easily follow and understand my Karel programs.

💬Essential Question:

Why do programmers add comments in their code, and how do comments make programs easier to understand?

📋Today's Agenda:

Watch & discuss: Commenting Your Code (CodeHS 1.6.1)
Practice adding comments (Guided & Partner Practice)
Reflect: Why comments matter

📚MSDE Standard 3B-AP-21

Students should be able to document programs to make them easier to follow, test, and debug.

🏫HCPS CS Standard

Students create programs that include documentation to explain their purpose and function.

🎮Why This Matters:

Professional game developers use comments all the time! When creating games like Minecraft or Fortnite, hundreds of programmers work on the same code. Comments help them understand what each other's code does without having to guess!

3

Guided Practice

👀What Are Comments?

Comments are notes in your code that Python ignores when running the program. They're just for humans to read! In Python, any line starting with # is a comment.

🤖Karel's Code Without Comments:

def main():
    move()
    jump_hurdle()
    move()
    jump_hurdle()
    move()
                

❌ Can you tell what this code is trying to do? It's hard to know!

✏️ Your Challenge: Let's add helpful comments to explain what's happening!

💡 Hint: Start each comment with the # symbol. Good comments explain WHY or WHAT the code does, like "Move to the first hurdle" or "Jump over obstacle."

Add Your Comments:

✨Example With Good Comments:

# Program to help Karel jump over two hurdles
def main():
    move()  # Move to the first hurdle
    jump_hurdle()  # Jump over the first obstacle
    move()  # Move to the second hurdle
    jump_hurdle()  # Jump over the second obstacle
    move()  # Move to the finish line
                

✅ Now it's much easier to understand what Karel is doing!

📱Real-World Connection:

Think about a recipe! When you bake cookies, the recipe doesn't just say "Add ingredients." It explains each step: "Mix butter and sugar until fluffy" or "Bake for 12 minutes." Comments work the same way in code—they explain each step clearly!

4

Partner Practice

👥Time to Practice Together!

Now you'll work with a partner on a real CodeHS challenge!

💻 Activity: Work on CodeHS 1.6.4: The Two Towers + Comments

📝Instructions:

First 5 minutes: Work with your partner to write the Karel program and add helpful comments.
Switch! After 5 minutes, trade computers with another pair of students.
Review: Read the new code and comments. Can you understand what the program does just by reading the comments?
Feedback: Add one improvement suggestion as a comment in their code.

⭐What Makes a GREAT Comment?

✅ Good: # Make Karel turn around to face the other direction

❌ Not Helpful: # Turn left (Too obvious!)

❌ Not Helpful: # asdfghjkl (Doesn't explain anything!)

💡 Partner Tips:

Take turns typing and explaining your thinking
Ask each other: "Why did we use this command here?"
Write comments that would help YOU understand the code if you looked at it next month!

🎨Think Like a Tour Guide:

Imagine you're giving a tour of your code to someone who's never seen it before. Your comments are like the signs and explanations that help visitors understand what they're looking at. "This section makes Karel climb stairs" is much better than just "Karel moves here"!

5

Hands-On Challenge & Reflection

🎯Final Challenge: Apply Your Skills!

Now it's time to prove you can apply comments to help others understand your code! Read the uncommented code below, then add helpful comments to make it clear.

🤖Mystery Karel Program - Add Comments!

def main():
    move()
    turn_left()
    move()
    move()
    turn_right()
    move()
    put_ball()
                

❓ What does this program do? Add comments to explain each step!

✏️Your Turn - Add 5 Comments:

Comment at the top (What's the program's goal?):

Comment for move():

Comment for turn_left():

Comment for move() move():

Comment for turn_right() and move():

Comment for put_ball():

🎓 Did You Apply the Objective? Look back at today's goal: "I can apply comments in Python so others — and I myself — can easily follow and understand my Karel programs." Did your comments help explain what the program does?

💭Exit Ticket - Reflect on Your Learning

Now that you've applied comments to a real program, answer these reflection questions:

1. How did adding comments help you understand your own code better today?

2. How can comments help someone else debug your program?

🌟Key Takeaways:

Comments start with the # symbol in Python
Good comments explain WHAT or WHY, not just repeat the code
Comments help YOU remember what you were thinking
Comments help OTHERS understand and improve your code
Professional programmers use comments every single day!

🚀Looking Ahead:

From now on, make it a habit to add comments to ALL your Karel programs! Future you (and your classmates) will thank you. Remember: Code is read way more often than it's written, so make it clear and easy to understand!

🎯Challenge for Next Time:

Go back to an old Karel program you wrote before today. Add comments to it, then show it to a friend. Can they understand what it does now? That's the power of good commenting!

Commenting Your Code with Karel