[파이썬 기본편] 2-5.주석

필자가 중학생이던 시절, 학교를 마치고 집에 왔는데 식탁에 웬 3천원이 놓여 있었습니다. 이 쪽지와 함께 말이죠.

배고프지? 자장면 사먹으렴                                       - 엄마가

그 때 당시 자장면은 딱 3천원이었고, 배가 고팠던 저는 바로 자장면을 시켜서 아주 맛있게 먹은 기억이 납니다. 

 

그런데 만약 쪽지가 없었다면 어땠을까요?

아마 저는 3천원이 왜 식탁에 놓였는지, 누가 올려둔 것인지, 무슨 용도인지, 제가 사용해도 되는 것인지, 왜 하필 3천원인지 등 의문을 가졌을 것입니다.

 

코딩을 하다 보면 분명 과거의 내가 만든 코드인데 이해가 잘 가지 않는 경우가 있습니다. 때로는 추가 설명이 필요한 복잡한 코드를 작성해야 할 때도 있으며, 특별한 의미를 가지는 어떤 값을 사용해야 할 때도 있습니다. 특히 다른 누군가와 함께 코드를 작성한다면 서로의 이해를 돕기 위한 부연 설명이 필요할 때도 있지요. 이럴 때 우리는 주석이란 것을 사용할 수 있습니다. 주석은 코드 내에 작성하지만 프로그램의 실행에는 아무런 영향을 끼치지 않습니다. 하지만 개발자에게는 아주 큰 의미를 전달하는 역할을 할 수도 있지요. 마치 식탁에 놓인 쪽지처럼 말이죠.

 

앞에서 봤던 예제 코드를 다시 가져와볼까요?

# 애완동물을 소개해 주세요~

print("우리집 강아지의 이름은 연탄이에요")
print("연탄이는 4살이며, 산책을 아주 좋아해요")
print("연탄이는 어른일까요? True")

여기에서 가장 첫 줄에 있는 '# 애완동물을 소개해 주세요~' 부분이 바로 주석입니다. 이 문장은 소스코드 상에 있지만 실행했을 때는 아무 동작을 하지 않고 그냥 무시가 되는데, 이렇게 # 으로 문장을 시작하게 되면 그 부분은 주석으로 처리가 됩니다. 

 

# 은 꼭 문장 맨 처음에 올 필요는 없어요. 어떤 명령문이 있고 그 명령문 뒤에 # 으로 시작하는 주석을 작성할 수도 있습니다. 중요한 것은 # 이후에 오는 모든 내용은 주석으로 인식된다는 점이에요.

print("우리집 강아지의 이름은 연탄이에요") # 이름 소개
print("연탄이는 4살이며, 산책을 아주 좋아해요") # 나이, 취미 소개
print("연탄이는 어른일까요? True") # 어른인지 여부 확인

주석은 보통 소스코드가 어떤 내용을 포함하고 있는지, 이 문장이 의미하는 것이 무엇인지, 왜 이렇게 쓰여졌는지, 주의할 점은 무엇인지, 추가로 알아야 할 내용은 무엇인지 등에 대해 설명이 필요할 때 사용합니다.

 

# 으로 시작하는 한 줄 주석 외에 여러 줄을 한꺼번에 주석 처리하는 방법도 있어요. 바로 작은 따옴표 3개 (''') 로 주석을 설정하려는 문장들 전체를 앞뒤로 감싸주는 것인데요. 이렇게 하면 print 문장 3개 전체를 모두 주석으로 설정하게 된답니다.

'''
print("우리집 강아지의 이름은 연탄이에요") # 이름 소개
print("연탄이는 4살이며, 산책을 아주 좋아해요") # 나이, 취미 소개
print("연탄이는 어른일까요? True") # 어른인지 여부 확인
'''

 

비주얼 스튜디오 코드에서 주석 단축키 주석 설정 : Ctrl + / 또는 Ctrl + k + c 주석 해제 : Ctrl + / 또는 Ctrl + k + u 주의 : 한 줄 주석인 경우 그 문장 위에 커서를 두고 단축키를 누르면 되며, 여러 줄 주석인 경우 먼저 주석 설정을 하기 위한 영역을 마우스 드래그 드롭이나 키보드 Shift + 방향키 (↑, ↓) 로 선택한 뒤에 단축키를 눌러주세요