[파이썬 주석 완전 정복] #부터 """까지, 코드 가독성 200% 올리는 비법 (단축키, 들여쓰기 꿀팁 포함!)

안녕하세요!
오늘은 파이썬 코드를 작성할 때 빼놓을 수 없는 중요한 요소, 바로 주석(Comments)에 대해 알아보려고 합니다. 주석은 프로그램 실행에는 영향을 주지 않지만, 코드를 이해하고 관리하는 데 큰 도움을 줍니다.

"이 코드가 왜 이렇게 작성됐지?", "나중에 내가 이 코드를 다시 봐도 이해할 수 있을까?" 이런 고민을 한 번이라도 해보셨다면, 주석의 중요성을 이미 알고 계실 거예요

이번 포스팅에서는 파이썬 주석의 종류부터 효과적으로 사용하는 방법, 그리고 주의할 점까지 쉽고 명확하게 알려드리겠습니다!

1. 파이썬 주석, 왜 필요할까요?

주석은 기본적으로 코드를 설명하는 글입니다. 파이썬 인터프리터는 주석을 무시하고 지나가기 때문에 프로그램의 실제 동작에는 아무런 영향을 미치지 않습니다. 하지만 사람에게는 매우 중요합니다!

가독성 향상: 복잡한 로직이나 특별한 의도를 가진 코드 옆에 주석을 달아두면, 나중에 코드를 다시 보거나 다른 사람이 코드를 볼 때 이해하기 훨씬 쉬워집니다.
협업 용이: 여러 사람이 함께 프로젝트를 진행할 때, 주석은 효과적인 의사소통 도구가 됩니다.
디버깅: 특정 코드 블록을 잠시 실행에서 제외하고 싶을 때, 해당 부분을 주석 처리하여 테스트해볼 수 있습니다.

잘 작성된 주석은 미래의 나에게, 그리고 동료에게 큰 선물이 될 수 있습니다.

2. 파이썬 주석의 종류와 사용법

파이썬에서는 크게 두 가지 종류의 주석을 사용합니다.

2.1. 한 줄 주석 (`#`)

가장 흔하게 사용되는 주석 형태로, # 기호로 시작합니다. # 뒤에 오는 모든 내용은 해당 줄의 끝까지 주석으로 처리됩니다.

# 이 변수는 사용자의 이름을 저장합니다.
user_name = "철수"

age = 30  # 사용자의 나이 (정수형)
print(user_name, age)  # 이름과 나이 출력

일반적으로 코드와 주석 사이에는 두 칸 정도의 공백을 두어 가독성을 높입니다.

2.2. 여러 줄 주석 (따옴표 세 개: `"""` 또는 `'''`)

여러 줄에 걸쳐 주석을 작성하고 싶을 때는 큰따옴표 세 개(""") 또는 작은따옴표 세 개(''')를 사용합니다.

"""
이것은 여러 줄 주석의 예시입니다.
이 함수는 두 숫자를 더하는 기능을 합니다.
매개변수:
    a (int): 첫 번째 숫자
    b (int): 두 번째 숫자
반환값:
    int: 두 숫자의 합
"""
def add_numbers(a, b):
    return a + b

'''
작은따옴표 세 개를 사용해도
동일하게 여러 줄 주석을
만들 수 있습니다.
'''
product_id = "SN001"

사실, 파이썬에서 """..."""나 '''...'''는 엄밀히 말해 여러 줄 문자열(multi-line string literal)입니다. 하지만 이 문자열이 코드의 특정 위치(모듈, 함수, 클래스의 첫 부분)에 오면 독스트링(Docstring)이라고 불리며, 해당 코드 객체에 대한 설명 문서 역할을 합니다. 일반적인 여러 줄 주석으로도 많이 활용됩니다.

3. 주석, 더 스마트하게 활용하기: 주석 단축키

매번 #을 입력하거나 """를 타이핑하는 것은 번거로울 수 있습니다. 대부분의 코드 편집기(IDE)는 주석 처리를 위한 편리한 단축키를 제공합니다.

대부분의 IDE (PyCharm, VS Code, Spyder 등):
- Windows/Linux: Ctrl + /
- macOS: Cmd + /
파이썬 IDLE (기본 편집기):
- 주석 생성: Alt + 3
- 주석 제거: Alt + 4

여러 줄을 한 번에 주석 처리하기:
주석 처리하고 싶은 코드 블록을 마우스로 드래그하여 선택한 후, 위 단축키를 사용하면 선택된 모든 줄이 한 번에 # 주석으로 처리됩니다. 다시 단축키를 누르면 주석이 해제됩니다.

# 아래 코드를 주석 처리하고 싶다면:
# def greet(name):
#     message = "안녕하세요, " + name + "님!"
#     print(message)
#
# a = 10
# b = 20
# greet("개발자")

4. 파이썬 주석 사용 시 주의사항: 들여쓰기의 중요성

한 줄 주석(#)은 코드의 어느 위치에 있든 들여쓰기와 관계없이 잘 작동합니다. 하지만 여러 줄 주석으로 사용되는 """...""" 또는 '''...''' (특히 독스트링으로 사용될 때)는 파이썬의 들여쓰기 규칙을 따라야 합니다.

잘못된 예시 (들여쓰기 오류 발생 가능):

class MyClass:
"""
이 클래스는 특별한 기능을 합니다. # 들여쓰기가 맞지 않음
메서드로는 do_something이 있습니다.
"""
    def __init__(self):
        self.value = 10

    def do_something(self):
        # 이 부분의 들여쓰기는 올바르지만, 클래스 독스트링의 들여쓰기가 문제
        print("무언가를 합니다.")

올바른 예시:

class MyClass:
    """
    이 클래스는 특별한 기능을 합니다.
    메서드로는 do_something이 있습니다.
    클래스 내부의 다른 코드들과 동일한 들여쓰기 수준을 가집니다.
    """
    def __init__(self):
        self.value = 10

    def do_something(self):
        """이 메서드에 대한 설명입니다."""
        print("무언가를 합니다.")

마무리하며

오늘은 파이썬에서 주석을 작성하는 다양한 방법과 유용한 팁, 그리고 주의사항까지 살펴보았습니다.
주석은 단순한 메모를 넘어, 잘 만들어진 소프트웨어의 중요한 일부입니다. 깔끔하고 명확한 주석을 작성하는 습관은 여러분의 코드를 더욱 빛나게 하고, 협업을 원활하게 만들어 줄 것입니다.