파이썬 주석(Comment)이란?
주석은 컴퓨터 프로그램의 소스 코드 안에 프로그래머가 읽고 이해할 수 있도록 작성하는 설명문 또는 메모입니다. 컴파일러와 인터프리터는 주석을 완전히 무시하기 때문에, 주석은 프로그램의 실행 결과에 아무런 영향을 미치지 않습니다. 코드의 의도를 설명하거나 협업 시 다른 개발자에게 정보를 전달하는 데 필수적인 요소입니다.
# 기호로 한 줄 주석 작성하기
파이썬 스크립트에서 # 기호는 주석의 시작을 나타내며, 그 효력은 해당 줄의 끝까지 유지됩니다. 만약 #이 줄의 첫 번째 문자라면 그 줄 전체가 주석으로 처리됩니다.
또한 #은 줄 중간에 사용할 수도 있습니다. 이 경우 # 앞에 있는 텍스트는 유효한 파이썬 표현식으로 해석되고, # 뒤에 오는 텍스트만 주석으로 취급됩니다.
#this is a comment
print ("Hello World")
print ("Welcome to TutorialsPoint") #this is also a comment but after a statement.위 예제에서 첫 번째 줄 전체가 주석이며, 세 번째 줄은 print 문 실행 후 # 뒤의 내용만 주석으로 처리되는 것을 확인할 수 있습니다.
여러 줄 주석(블록 주석) 작성하기
파이썬에는 C나 Java 같은 언어에 있는 /* */ 형태의 여러 줄 주석 또는 블록 주석을 위한 별도의 문법이 제공되지 않습니다. 대신 각 줄마다 줄 시작 부분에 # 기호를 붙여 주석으로 표시해야 합니다.
다행히 대부분의 파이썬 IDE(PyCharm, VS Code 등)에서는 코드 블록을 선택한 뒤 단축키(Ctrl+/ 또는 Cmd+/)를 눌러 여러 줄을 한 번에 주석 처리하거나 해제할 수 있는 기능을 제공합니다.
삼중 따옴표 문자열을 활용한 주석
함수나 클래스의 독스트링(docstring)이 아닌 경우, 삼중 따옴표(''' 또는 """)로 묶인 여러 줄 문자열도 사실상 주석처럼 동작합니다. 인터프리터가 이 문자열을 평가하지 않고 넘어가기 때문입니다.
'''
comment1
comment2
comment3
'''
print ("Hello World")다만 이 방식은 실제 문자열 객체가 생성되므로 엄밀한 의미의 주석은 아니며, 공식적으로 권장되는 방법은 함수·클래스 설명에는 독스트링을, 일반적인 코드 설명에는 # 주석을 사용하는 것입니다.