파이썬 협업을 위한 주석 처리 팁

파이썬으로 코드를 작성하다 보면 # 기호로 시작하는 문장을 자주 보게 되는데요, 이건 바로 주석(comment) 이라고 해요. 주석은 코드 실행에는 전혀 영향을 주지 않지만, 나중에 코드를 다시 보거나 다른 사람과 협업할 때 아주 중요한 역할을 해요.

이번 글에서는 파이썬 주석이 무엇인지부터, 어떻게 잘 쓸 수 있는지까지 하나씩 친절하게 알려드릴게요.

1. 주석이란 무엇인가요?

주석은 코드를 설명하는 메모예요. 파이썬은 주석을 그냥 무시하고 넘어가기 때문에, 프로그램 실행에는 아무런 영향을 주지 않아요.

하지만 주석이 중요한 이유는 분명해요.

• 코드를 더 쉽게 이해할 수 있어요
• 다른 사람과 협업할 때 도움을 줘요
• 미래의 내가 코드를 다시 볼 때 큰 힌트가 돼요

# 사용자 이름을 입력받아 인사하는 함수
def greet(name):
    return "Hello, " + name

이처럼 한 줄의 설명만으로도 코드가 훨씬 이해하기 쉬워졌죠?

2. 파이썬에서 주석 다는 방법

(1) 한 줄 주석

파이썬에서는 # 기호를 사용해서 한 줄 주석을 달 수 있어요.

# 이것은 한 줄 주석이에요
print("Hello, world!")  # 출력문 옆에 이렇게도 쓸 수 있어요

(2) 여러 줄 주석처럼 보이는 방법

파이썬에는 공식적인 여러 줄 주석 문법은 없지만, 보통 문자열을 활용해서 여러 줄 주석처럼 쓰기도 해요.

"""
이건 여러 줄 주석처럼 보이지만
사실은 문자열이에요!
"""
print("Hello")

다만 이 방식은 실제로는 문자열(string)이라 코드에 영향을 줄 수도 있지만, 변수에 저장되지 않으면 무시돼요. 그래서 주석처럼 보이지만 완전히 같은 건 아니에요.

여러 줄을 주석 처리하고 싶을 땐, 에디터의 단축키를 쓰는 게 더 좋아요. 예를 들어, VSCode에서는 window는(Ctrl + /)로, macOS는 (Cmd + /)를 사용해 여러 줄을 한꺼번에 주석 처리할 수 있어요.

3. 좋은 주석 vs 나쁜 주석

주석은 너무 많아도, 너무 없어도 문제예요.

중요한 건 "어떤 주석을 다느냐"예요.

❌ 이런 주석은 별로예요

x = x + 1  # x에 1을 더함

→ 이건 코드만 봐도 알 수 있기 때문에 굳이 주석이 필요하지 않아요.

✅ 이런 주석은 좋아요

x = x + 1  # 사용자의 입력값을 보정하기 위해 1을 더함

→ 코드의 목적이나 이유를 알려주기 때문에 훨씬 유용해요.

4. 주석 작성 팁

주석을 잘 쓰고 싶다면 아래 팁을 참고해 보세요:

• 너무 많지도, 너무 적지도 않게 쓰기
• "무엇"보다는 "왜"를 설명하기
• 짧고 간결하게 쓰기
• 스타일을 일관되게 유지하기

예를 들어, 아래처럼 쓰는 것이 좋아요:

# 로그인 실패 횟수가 5회 이상일 때 계정을 잠금 처리
if failed_attempts >= 5:
    lock_account(user)

5. 실습 예제: 주석을 직접 달아보세요!

아래 코드를 보고, 어떤 역할을 하는지 주석을 달아보는 연습을 해보세요:

def calculate_discount(price, percentage):
    discounted_price = price * (1 - percentage / 100)
    return discounted_price

힌트: 함수 이름, 인자 이름, 계산식의 의미를 생각해 보세요.

"얼마에서 몇 퍼센트를 빼서 얼마가 되는지" 같은 설명이 들어가면 좋겠죠?

마무리 정리

• 주석은 코드에 영향을 주지 않지만, 가독성과 협업에 큰 도움이 돼요.
• 파이썬에서는 # 기호로 주석을 달아요.
• 좋은 주석은 "무엇을" 보다는 "왜"를 설명하고, 코드를 더 이해하기 쉽게 도와줘요.
• 너무 길거나 너무 자주 쓰는 건 오히려 가독성을 해칠 수 있으니, 꼭 필요한 곳에만 간결하게 쓰는 게 좋아요.

주석은 단순한 코드 설명을 넘어서, 코드에 말을 걸 수 있는 방법이에요.

잘 작성한 주석 하나가 코드를 더 깨끗하게, 더 이해하기 쉽게 만들어줘요.

파이썬, 45만원 국비 지원 받고 배우고 싶다면?

파이썬을 더 쉽고 재밌게 배우고 싶다면, 코드잇의 국비지원 강의 <Python 프로그래밍 기초> 과정을 추천드려요. 내일배움카드만 있다면 누구나 45만원 국비 지원을 받고 합리적인 비용에 수강할 수 있어요.