Python - 주석 (Comment)

주석이란? 

프로그래밍 언어로 작성된 소스코드를 해석하는 일은 쉬운 일이 아닙니다. 만약 아주 많은 양의 소스코드를 작성하고 다른 사람들이 보거나, 또는 오랜 시간이 경과된 후에 볼 때 프로그래밍 언어로 작성된 소스코드를 보는 것은 쉬운 일은 아닙니다. 때문에 다양한 프로그래밍 언어에서는 소스코드를 안내하기 위한 주석(Comment)을 제공합니다.

 

이 주석은 컴퓨터에서 받아들이지 않고 오로지 사용하는 유저에게만 보이게 하는 기능입니다. 

이번 포스트에서는 Python에서 주석을 사용하는 방법에 대해 알아보도록 하겠습니다.

 

기본 주석 사용 법 - 한줄 주석

파이썬을 이용하여 소스코드를 작성하고자 할 때 기본적으로 주석 처리를 하는 방법은 아래와 같습니다.

 

• 주석처리하고 싶은 시작 점에 #을 붙인다.

#을 붙이면 #부터 그 줄의 종료되는 시점까지 주석 처리가 됩니다.

 

# 한줄 주석 처리하는 방법
print("주석처리")
name = "GGG" #이름을 입력

 

여러 줄 주석 사용 법

만약 여러분들이 파이썬을 통하여 소스코드를 작성하다가 여러 줄로 주석을 처리하고 싶은 경우가 생깁니다.

이런 경우 파이썬에서 근본적으로 제공하는 방법은 한 줄 주석밖에 없기 때문에 아래와 같이 사용하는 것을 권장합니다.

# 파이썬에서는 여러줄 주석을 처리하는 특별한 키워드는 없다.
# 따라서 여러줄 주석을 하고 싶으면 모든 줄에 #을 이용한다.
# 다양한 IDE 툴에서는 여러줄을 한번에 주석을 처리하기 위한 기능을 제공합니다.
# 물론 편법도 존재하긴 합니다.

 

물론 다른 방법의 편법 또한 존재합니다. 바로 3중 따옴표(''') 또는 3중 큰따옴표(""")를 이용하는 방법입니다.

사실 정확한 의미에서 이 표현은 주석처리가 아닌 여로 줄을 문자열로 처리하는 방법입니다. 

이 방법을 사용하여 문자열 처리를 한다면 주석과 같은 효과를 얻을 수도 있습니다.

 

정상적인 3중 따옴표/큰따옴표 사용 예시

text ="""사실 3중 따옴표 
또는 3중 큰따옴표는 이런식으로 '여러줄의 문자열을 처리'하고
표현하기 위해 사용되는 파이썬 기법입니다"""
print(text)

하지만! 문자열을 아무 변수에 넣어주지 않는 다면 아무런 동작을 하지 않습니다. 이를 이용해 약간의 편법으로 여러 줄 주석을 처리할 수 있게 됩니다.

'''
 사실 여러줄 문자열 처리를 하는 방법이지만
 아무 변수에 담지 않는다면 내부적으로 처리를 하지만 
 표시되지는 않습니다. 이런 편법을 이용한 여러줄 주석을 할 수 있습니다만,
 권장하지는 않습니다.
'''

 

이상 포스트를 마무리 하겠습니다.