1-4. 주석과 코드 작성 규칙

1-4. 주석과 코드 작성 규칙

파이썬을 배우다 보면 “코드는 작성하는 것뿐 아니라 읽기 좋게 작성하는 것”도 매우 중요하다는 걸 느끼게 됩니다. 이를 위해 주석(comment) 과 코드 작성 규칙(스타일 가이드) 이 존재합니다.

이 글에서는 주석의 작성 방법과 활용법, 그리고 가독성을 높이기 위한 코딩 스타일을 소개합니다.

---

주석(Comment)이란?

주석은 코드에 대한 설명을 적어두는 것으로, 프로그램 실행에는 영향을 주지 않습니다. 다른 사람이 코드를 읽거나, 나중에 자신이 다시 코드를 이해할 때 매우 유용합니다.

한 줄 주석

파이썬에서 주석은 # 기호로 시작합니다.

# 이것은 한 줄 주석입니다. print("Hello") # 이 부분도 주석입니다.

여러 줄 주석 (문서 설명용)

파이썬에는 여러 줄 주석 문법이 따로 없지만, 문자열을 활용해 여러 줄 주석처럼 사용할 수 있습니다.

 

""" 
이것은 여러 줄 설명입니다. 
보통 함수나 클래스 정의 위에 사용합니다. 
""" 
print("Hello")

---

주석 작성 팁

• 짧고 명확하게, 핵심만 설명
• 너무 당연한 설명은 생략
• 팀 협업 시에는 통일된 스타일 유지

 

# 사용자의 이름을 입력받습니다. 
name = input("이름을 입력하세요: ")

---

파이썬 코드 작성 규칙 (PEP8)

파이썬에는 공식 스타일 가이드인 PEP8이 존재합니다. 이는 코드 가독성을 높이기 위해 정리된 규칙 모음입니다.

주요 작성 규칙 요약

항목	규칙	예시
들여쓰기	공백 4칸 사용	print("Hello")
한 줄 길이	79자 이내	너무 길면 다음 줄로 나눔
변수명	소문자 + 언더스코어	user_name, total_price
함수명	소문자 + 언더스코어	get_name(), save_data()
클래스명	첫 글자 대문자 (CamelCase)	class UserProfile:
상수명	모두 대문자 + 언더스코어 사용	PI = 3.14

 

잘못된 예시

 

A=10 # 공백 없음 
def PrintName(): # 함수명은 소문자여야 함 
    print("이름")

올바른 예시

a = 10 # 공백 없음 
def PrintName():
    print("이름")

 

---

주석 vs 코드 품질

주석은 보조 도구일 뿐입니다. 진짜 좋은 코드는 주석 없이도 이해 가능한 코드입니다. 복잡한 코드를 쓸 때는 주석으로 보완하되, 가능한 한 간단하고 직관적인 코드를 우선하세요.

---

실전 연습: 코드에 주석 달기

# 사용자의 나이를 입력받습니다. 
age = int(input("나이를 입력하세요: ")) 

# 성인 여부를 판단합니다. 
if age >= 18: 
    print("성인입니다.") 
else: 
    print("미성년자입니다.")

---

마무리

이번 시간에는 파이썬에서 주석 작성법과 코드 스타일 규칙(PEP8) 에 대해 배웠습니다. 이 규칙을 습관처럼 지키면, 나중에 팀 프로젝트나 취업 준비에서도 큰 도움이 됩니다.