Original article: Python Multiline Comment – How to Comment Out Multiple Lines in Python
주석은 모든 프로그래밍 언어에서 필수적인 요소입니다. 주석을 활용하면 코드에 대한 이해력을 향상시킬 수 있고, 코드의 가독성을 높일 수 있으며, 팀 동료들이 코드의 동작 방식을 이해하도록 도울 수 있습니다.
주석은 컴파일러와 인터프리터에 의해 무시되므로 따로 실행되지 않습니다.
코드의 가독성을 높이는 것 외에도 주석은 디버깅할 때 도움이 됩니다. - 두 줄의 코드가 있다면 그 중 하나는 실행되지 않게끔 주석으로 처리할 수 있습니다.
다른 프로그래밍 언어와 마찬가지로 파이썬 또한 주석을 지원합니다.
그런데 파이썬에는 여러 줄 주석에 대한 내장된 메커니즘이 없습니다.
그러므로 이번 포스팅에서는 Python에서 한 줄 주석을 만드는 방법 뿐만 아니라 여러 줄 주석을 만들기 위한 대안도 보여드리겠습니다.
Python에서 한 줄 주석을 만드는 방법
Python에서 한 줄 주석을 만드려면 각각의 줄에서 맨 앞에 해시(#)를 붙입니다.
# print("Hello world")
print("Hello campers")
출력 결과:
Hello campers
보시는 바와 같이 주석처리된 줄은 출력되지 않았습니다.
Python에서 여러 줄 주석을 만드는 방법
JavaScript, Java, C++처럼 여러 줄 주석 처리시 /*...*/를 사용하는 다른 프로그래밍 언어와는 다르게 Python에는 여러 줄 주석과 관련하여 내장된 메커니즘이 없습니다.
Python에서 여러 줄로 주석 처리를 하기 위해 각 줄마다 맨 앞에 해시(#)를 붙일 수 있습니다.
# print("Hello world")
# print("Hello universe")
# print("Hello everyone")
print("Hello campers")
출력 결과:
Hello campers
이러한 접근을 통해 기술적으로 한 줄 주석을 여러 개 만들 수 있습니다.
Python에서 여러 줄 주석을 만들기 위한 진정한 대안은 독스트링(docstrings) 을 사용하는 것입니다.
Python 코드에서 여러 줄 주석을 달기 위해 독스트링을 사용하면 해당 코드 블록은 무시될 것이며 독스트링 바깥에 있는 코드만 실행될 것입니다.
"""
독스트링으로 만든 여러 줄 주석입니다
print("Hello world")
print("Hello universe")
print("Hello everyone")
"""
print("Hello campers")
출력 결과:
Hello campers
주의: 주석 처리를 위해 독스트링을 사용할 때 들여쓰기에 유의하세요. 4칸 들여쓰기(또는 Tab 키)를 사용한다면 들여쓰기 에러가 발생할 수 있습니다.
예를 들어 아래의 코드는 잘 동작합니다.
def addNumbers(num1, num2, num3):
"""
세 숫자의 합을 반환하는 함수
"""
return num1 + num2 + num3
print(addNumbers(2, 3, 4))
# 출력 결과: 9
하지만 아래의 코드는 동작하지 않습니다.
def addNumbers(num1, num2, num3):
"""
세 숫자의 합을 반환하는 함수
"""
return num1 + num2 + num3
print(addNumbers(2, 3, 4))
IDE에는 다음 에러가 발생합니다. "IndentationError: expected an indented block"
결론
Python에는 여러 줄 주석을 지원하는 내장 기능이 없기 때문에 이 포스팅에서는 독스트링을 대안으로 사용하는 방법을 다루었습니다.
독스트링으로 여러 줄 주석을 만들 수 있더라도 보통의 경우에는 해시(#)를 사용해서 Python에 규정된 주석 방침을 고수해야 합니다. 독스트링의 주된 목적은 코드에 주석을 다는 것이 아니라 문서화를 하기 위한 것이기 때문입니다.
이 포스팅이 유익했다면, 친구들과 가족들에게 공유해보세요.
읽어주셔서 감사합니다.