WeniVooks

검색

Cursor 톺아보기 with Python

코드에 설명 추가하기

Chapter 3-2: 코드에 설명 추가하기

🎯 이번 시간에 배울 것
  • 코드에 설명(주석) 추가하기
  • 내 코드를 더 이해하기 쉽게 만들기
🌟 지난 시간 돌아보기

Chapter 3-1에서 Edit 기능으로 코드를 개선했죠!

하지만 아직도 이런 고민이 있을 수 있어요:

  • "이 코드가 무엇을 하는지 잘 모르겠어요"
  • "나중에 다시 보면 이해하기 어려울 것 같아요"

바로 이럴 때 필요한 것이 주석(설명)입니다!

📝 왜 주석이 중요할까요?
주석이 없는 코드
x = 5
y = 3
if x > y:
    result = x * 2
else:
    result = y * 2
print(result)
x = 5
y = 3
if x > y:
    result = x * 2
else:
    result = y * 2
print(result)

이 코드가 무엇을 하는지 알 수 있나요? 🤔

주석이 있는 코드
# 두 숫자 중 더 큰 숫자를 찾아서 2배로 만들기
first_num = 5
second_num = 3
 
# 어느 숫자가 더 큰지 비교
if first_num > second_num:
    result = first_num * 2  # 첫 번째 숫자가 더 크면 2배
else:
    result = second_num * 2  # 두 번째 숫자가 더 크거나 같으면 2배
 
# 결과 출력
print("결과:", result)  # 결과: 10
# 두 숫자 중 더 큰 숫자를 찾아서 2배로 만들기
first_num = 5
second_num = 3
 
# 어느 숫자가 더 큰지 비교
if first_num > second_num:
    result = first_num * 2  # 첫 번째 숫자가 더 크면 2배
else:
    result = second_num * 2  # 두 번째 숫자가 더 크거나 같으면 2배
 
# 결과 출력
print("결과:", result)  # 결과: 10

이제 코드가 완전히 이해되죠! 😊

🚀 실습 1: 코드에 설명 추가하기
원래 코드
numbers = [1, 2, 3, 4]
result = []
for num in numbers:
    if num % 2 == 0:
        result.append("짝수")
    else:
        result.append("홀수")
print(result)
numbers = [1, 2, 3, 4]
result = []
for num in numbers:
    if num % 2 == 0:
        result.append("짝수")
    else:
        result.append("홀수")
print(result)
Edit로 설명 추가하기

1. 코드 전체 선택하고 Ctrl+K 2. 요청: "이 코드에 설명을 추가해주세요"

개선된 결과
# 짝수와 홀수를 판단하는 프로그램
numbers = [1, 2, 3, 4]  # 확인할 숫자들
result = []  # 결과를 저장할 리스트
 
# 각 숫자를 하나씩 확인
for num in numbers:
    if num % 2 == 0:  # 2로 나눈 나머지가 0이면 짝수
        result.append("짝수")  # 짝수라고 기록
    else:
        result.append("홀수")  # 홀수라고 기록
 
# 결과 출력
print("숫자들:", numbers)
print("판단 결과:", result)  # ['홀수', '짝수', '홀수', '짝수']
# 짝수와 홀수를 판단하는 프로그램
numbers = [1, 2, 3, 4]  # 확인할 숫자들
result = []  # 결과를 저장할 리스트
 
# 각 숫자를 하나씩 확인
for num in numbers:
    if num % 2 == 0:  # 2로 나눈 나머지가 0이면 짝수
        result.append("짝수")  # 짝수라고 기록
    else:
        result.append("홀수")  # 홀수라고 기록
 
# 결과 출력
print("숫자들:", numbers)
print("판단 결과:", result)  # ['홀수', '짝수', '홀수', '짝수']
🎉 놀라운 변화!

Before: 무슨 일을 하는지 모름 After: 모든 동작이 명확하게 이해됨

🎮 실습 2: 간단한 게임에 설명 추가하기
원래 코드
import random
 
choices = ["가위", "바위", "보"]
user = input("선택: ")
computer = random.choice(choices)
 
print(computer)
 
if user == computer:
    print("무승부!")
elif user == "가위" and computer == "보":
    print("승리!")
else:
    print("패배!")
import random
 
choices = ["가위", "바위", "보"]
user = input("선택: ")
computer = random.choice(choices)
 
print(computer)
 
if user == computer:
    print("무승부!")
elif user == "가위" and computer == "보":
    print("승리!")
else:
    print("패배!")
Edit으로 설명 추가

코드 전체 선택 → Ctrl+K → "이 게임에 설명을 추가해주세요"

개선된 결과
import random
 
# 가위바위보 게임
print("=== 가위바위보 게임 ===")
 
# 선택 가능한 것들
choices = ["가위", "바위", "보"]
 
# 사용자 입력 받기
user = input("가위, 바위, 보 중 선택하세요: ")
 
# 컴퓨터가 랜덤으로 선택
computer = random.choice(choices)
 
# 결과 보여주기
print("컴퓨터:", computer)
print("사용자:", user)
 
# 승부 판정
if user == computer:
    print("🤝 무승부!")  # 같으면 비김
elif user == "가위" and computer == "보":
    print("🎉 승리!")  # 가위가 보를 이김
else:
    print("😅 패배!")  # 나머지는 모두 패배
import random
 
# 가위바위보 게임
print("=== 가위바위보 게임 ===")
 
# 선택 가능한 것들
choices = ["가위", "바위", "보"]
 
# 사용자 입력 받기
user = input("가위, 바위, 보 중 선택하세요: ")
 
# 컴퓨터가 랜덤으로 선택
computer = random.choice(choices)
 
# 결과 보여주기
print("컴퓨터:", computer)
print("사용자:", user)
 
# 승부 판정
if user == computer:
    print("🤝 무승부!")  # 같으면 비김
elif user == "가위" and computer == "보":
    print("🎉 승리!")  # 가위가 보를 이김
else:
    print("😅 패배!")  # 나머지는 모두 패배
🔧 좋은 주석 작성법
좋은 주석 vs 나쁜 주석

✅ 좋은 주석:

# 18세 이상이면 성인으로 판단
is_adult = age >= 18
 
# 사용자가 입력한 숫자를 2배로 만들기
doubled = user_input * 2
# 18세 이상이면 성인으로 판단
is_adult = age >= 18
 
# 사용자가 입력한 숫자를 2배로 만들기
doubled = user_input * 2

❌ 필요 없는 주석:

# i에 1을 더함
i = i + 1
 
# x와 y를 더하기
result = x + y
# i에 1을 더함
i = i + 1
 
# x와 y를 더하기
result = x + y
간단한 코드 설명 작성법
# 두 숫자를 더하는 계산
first = 10
second = 20
result = first + second  # 두 숫자를 더함
print("결과:", result)
 
# 사용자에게 인사하기
name = "김철수"
print(f"안녕하세요, {name}님!")  # 이름과 함께 인사말 출력
# 두 숫자를 더하는 계산
first = 10
second = 20
result = first + second  # 두 숫자를 더함
print("결과:", result)
 
# 사용자에게 인사하기
name = "김철수"
print(f"안녕하세요, {name}님!")  # 이름과 함께 인사말 출력
🎯 실습 3: 나만의 코드에 설명 추가하기

직접 코드를 만들고 Edit로 설명을 추가해보세요!

미션: 점수 계산 프로그램

시작 코드:

score = 85
if score >= 90:
    grade = "A"
elif score >= 80:
    grade = "B"
elif score >= 70:
    grade = "C"
else:
    grade = "F"
print(grade)
score = 85
if score >= 90:
    grade = "A"
elif score >= 80:
    grade = "B"
elif score >= 70:
    grade = "C"
else:
    grade = "F"
print(grade)
개선 미션

1. 코드 전체 선택하고 Ctrl+K 2. 요청: "이 점수 계산 프로그램에 설명을 추가해주세요"

다음과 같이 개선될 거예요:

# 점수를 등급으로 바꾸는 프로그램
score = 85  # 내 점수
 
# 점수에 따라 등급 계산하기
if score >= 90:
    grade = "A"  # 90점 이상은 A등급
elif score >= 80:
    grade = "B"  # 80점 이상은 B등급
elif score >= 70:
    grade = "C"  # 70점 이상은 C등급
else:
    grade = "F"  # 70점 미만은 F등급
 
# 결과 출력
print(f"점수 {score}점의 등급: {grade}")  # B등급
print("등급 계산이 완료되었습니다!")
# 점수를 등급으로 바꾸는 프로그램
score = 85  # 내 점수
 
# 점수에 따라 등급 계산하기
if score >= 90:
    grade = "A"  # 90점 이상은 A등급
elif score >= 80:
    grade = "B"  # 80점 이상은 B등급
elif score >= 70:
    grade = "C"  # 70점 이상은 C등급
else:
    grade = "F"  # 70점 미만은 F등급
 
# 결과 출력
print(f"점수 {score}점의 등급: {grade}")  # B등급
print("등급 계산이 완료되었습니다!")
🌟 학습 성과 체크
오늘 배운 내용
✅ 코드에 설명(주석) 추가하는 방법
✅ Edit 기능으로 설명 자동 추가하기
✅ 좋은 주석과 나쁜 주석 구분하기
✅ 코드에 설명(주석) 추가하는 방법
✅ Edit 기능으로 설명 자동 추가하기
✅ 좋은 주석과 나쁜 주석 구분하기
🎉 마무리

축하합니다! 이제 여러분은 코드 설명 추가를 할 수 있습니다! ✨

🔥 오늘의 성취
  1. 주석 추가하는 방법 습득
  2. 코드를 더 이해하기 쉽게 만드는 방법 습득
  3. Edit 기능으로 설명 자동 추가하기
💡 다음 시간 예고

다음 Chapter 3-3에서는 **"더 안전한 코드 만들기"**를 배워보겠습니다!

🎯 오늘의 과제

직접 Edit 기능을 사용해서 여러분만의 코드에 설명을 추가해보세요!

여러분의 코드는 이제 누구나 쉽게 이해할 수 있습니다! 🚀

{"packages":["numpy","pandas","matplotlib","lxml"]}
3.1 Ctrl+K 기능 - 코드 간단히 고치기3.3 더 안전한 코드 만들기