주석은 코딩을 할 때 거의 필수적인 요소가 아닌가 싶습니다. 그래서 본 포스팅에서는 파이썬의 주석 comment에 대해 다루어볼까합니다.
주석은 상황에 따라 한 줄 주석을 사용해야 할 때가 있고 여러 줄 주석을 써야 할 때가 있습니다.
한 줄 주석: #
파이썬에서 한 줄에만 주석을 달고 싶으실때는 ‘#’을 해당 줄 맨 앞에다 사용하시면 됩니다.
# 파이썬 주석 예시
def example():
print("This is just an example function.")정확히는 ‘#’ 이후에 쓰는 글들이 주석으로 인식 되는 것이기 때문에 코드가 있는 줄에도 주석을 달 수 있습니다.
def example():
print("This is just an example function.") # 파이썬 주석 예시여러 줄 주석: ”’ ”’, “”” “””
파이썬에서 여러 줄 주석을 달려면 작은 따옴표 또는 큰 따옴표 3개를 연속으로 사용하시면 됩니다.
작은 따옴표
'''
작은 따옴표 세개를 사용해서 여러 줄 주석을 다는 예시입니다.
보통 조금 긴 주석을 달아야해서 여러 줄로 넘어가거나 함수나 블럭을 주석으로 만들때 사용합니다.
이렇게 작은 따옴표 3개로 주석의 시작을 알리고 다시 작은 따옴표 3개를 써서 주석의 끝을 알립니다.
'''
def example():
print("This is just an example function.")큰 따옴표
"""
큰 따옴표 세개를 사용해서 여러 줄 주석을 다는 예시입니다.
작은 따옴표를 사용할때와 똑같이 따옴표 3개로 주석의 시작을 알리고 다시 따옴표 3개를 써서 주석의 끝을 알립니다.
"""
def example():
print("This is just an example function.")주석 단축키
한 줄 주석 단축키
주로 vscode, 파이썬 IDLE 또는 주피터 노트북 등의 개발환경을 사용하실텐데요.
다른 환경들이라 해도 대부분 동일한 단축키로 설정되어있습니다.
MacOS: command + /
Window: Ctrl + /
주석이 없는 곳에 커서가 있고 단축키를 사용하면 생성이 되고, 있는 곳에 사용하면 해제가 되는 토글(toggle) 형식입니다.
여러 줄 주석 단축키
여러 줄 주석을 달 때도 같은 단축키를 사용합니다. 여러 줄을 드래그 한 후 단축키를 눌러야 한다는 것이 차이점입니다.
여기서 조금 의아할 수 있는 부분은 여러 줄 주석을 단축키를 통해 사용할 때 따옴표 세개가 나오는 것이 아니라 ‘#’ 한 줄 주석이 여럿 나온다는 점입니다.
이렇게 주석으로 만들 여러 줄을 드래그 하신 후, 단축키를 사용하시면 줄마다 앞에 ‘#’ 이 달리면서 주석이 됩니다.
파이썬 주석 처리 주의사항
파이썬에서 다른 언어들과 조금 달리 주석 처리를 할 때 주의사항이 있습니다. 바로 들여쓰기 관련인데요. 파이썬은 들여쓰기를 통해 함수나 블럭의 범위를 인식하기 때문에 주석 처리를 할 때도 마찬가지로 주의해주셔야 합니다.
이렇게 들여쓰기를 신경쓰지않고 for문 다음 줄에 주석을 달아보았습니다. IdentationError (들여쓰기) 에러가 발생하는 것을 확인할 수 있었습니다.
들여쓰기에 맞춰 주석을 사용했을때는 정상적으로 실행되는 것을 확인 할 수 있습니다.