[Python] 파이썬 주석 사용법 (한 줄 주석, 여러 줄 주석, 단축키, 들여쓰기 주의사항)
안녕하세요. BlockDMask 입니다.
오늘은 파이썬의 주석 사용법에 대해 알아보겠습니다.
파이썬에서는 한 줄 주석과 여러 줄 주석을 지원하며, 상황에 맞게 자유롭게 사용할 수 있습니다.
혹시 알고 계셨나요? 파이썬에서 일부 주석은 들여쓰기를 맞춰주지 않으면 에러가 발생할 수 있습니다.
저도 과거에 파이참(PyCharm)에서 주석 때문에 컴파일 에러가 발생한 적이 있어 이 글을 작성합니다.
1. 파이썬 주석의 종류
▶ 한 줄 주석: #
한 줄 주석은 # 기호로 작성합니다.
예제 1 - 빈 줄에 주석 달기
# 파이썬 한 줄 주석 예제 1
def comment_example():
print("주석 예제. DMask")
보통 # 다음에 한 칸 띄우고 주석을 작성하는 것이 권장됩니다.
예제 2 - 문장 끝에 주석 달기
def comment_example():
print("주석 예제. 가면") # 한 줄 주석 예제 2▶ 여러 줄 주석: 큰따옴표 3개, 작은따옴표 3개
파이썬에서는 여러 줄 주석도 작성할 수 있습니다.
1) 큰따옴표 3개 (""" ... """)
def comment_example():
print("주석 예제. Block")
"""
여러 줄 주석 예제입니다.
이렇게 여러 줄로 설명을 작성할 수 있습니다.
마지막에 다시 큰따옴표 3개를 입력하면 주석이 끝납니다.
"""
a = 3 # 일반 코드 1
b = 4 # 일반 코드 2
2) 작은따옴표 3개 (''' ... ''')
while True:
'''
이 프로그램은 여러 작업을 수행합니다.
사용할 때는 출처를 남겨주세요.
추가 설명도 가능합니다.
'''
print("=" * 30)
2. 주석 단축키 (파이참, IDLE, VSCode 등)
단축키를 이용하면 주석을 쉽게 추가하거나 제거할 수 있습니다. 대부분의 에디터에서 비슷한 단축키를 지원합니다.
▶ 파이참, VSCode, 일반 IDE 단축키
- Windows:
CTRL + / - Mac OS:
Command + /
▶ 파이썬 IDLE 전용 단축키
- 주석 추가:
ALT + 3 - 주석 제거:
ALT + 4
▶ 여러 줄 주석 처리 예시
선택 영역을 지정한 후 단축키를 입력하면 여러 줄을 한 번에 주석 처리할 수 있습니다.
원본 코드:
def add_numbers(a, b):
print(f"{a} + {b} = {a + b}")
a = 10
b = 20
add_numbers(a, b)
단축키 적용 후:
# def add_numbers(a, b):
# print(f"{a} + {b} = {a + b}")
#
# a = 10
# b = 20
# add_numbers(a, b)3. 파이썬 주석 작성 시 주의사항 (들여쓰기 중요)
C, C++, C# 등에서는 주석 위치가 크게 중요하지 않지만, 파이썬에서는 들여쓰기가 매우 중요합니다.
잘못된 예제:
class CommentExample:
'''
파이썬 주석은 들여쓰기를 맞춰야 합니다. 이 경우 에러 발생
'''
def __init__(self):
a = 10
b = 20
발생하는 에러: IndentationError: expected an indented block
올바른 예제:
class CommentExample:
'''
파이썬 주석은 들여쓰기를 맞춰야 합니다.
'''
def __init__(self):
a = 10
b = 20
이상으로 파이썬 주석 사용법을 정리해보았습니다.
읽어주셔서 감사합니다.
댓글
댓글 쓰기