파이썬 주석 사용법

컴퓨터 프로그래밍에서는 해당 코드나 로직에 대한 설명이나 코드 파일의 메타데이터 작성, 혹은 코드 내부에 임시 todolist작성등 여러 가지 상황에서 주석을 사용합니다.

 

물론 파이썬에도 주석기능이 있는데요, 이번 포스팅에서는 파이썬에서 주석을 사용하는 방법을 알아보겠습니다.

 

파이썬에서 주석을 사용하려는 경우, 문자열 표현(e.g. "this is #(?) of string" 은 틀린 주석)을 감싸는 큰 따옴표 내부가 아닌 위치에서 '#'(샾-sharp) 문자를 주석으로 사용하고 싶은 문장 앞에 추가해 주시면 해석기가 주석으로 인식하게 됩니다.

#한 줄 주석입니다.

 

이때 주석 문장 앞에 # 문자를 붙이는 방식은 주석이 만약 여러 줄로 되어 있을 경우 각 줄마다 일일히 # 문자를 붙여야 하는 번거로움이 발생하게 됩니다.

 

그래서 파이썬에서 비공식적이긴 하지만 이런 번거로움을 덜기 위해 주석이 여러 줄인 경우, 큰 따옴표 3개로 주석 문단을 감싸서 여러 줄로 된 주석을 작성하기도 합니다.

예를 들어 비공식적인 방법으로 여러 줄 주석을 표현하려면

"""여러 줄

(multiple lines)

로 된

주석의 예제입니다.
"""

위의 방식으로 작성해 주시면 됩니다.

 

하지만 이는 파이썬에서 엄밀히 주석이 아닌 일종의 문자열 값으로 인식하게 되는데, 큰 따옴표 3개를 감싸는 방식은 사실 '문자열을 정의할때에 어떤 공백 문자도 문자열로 허용하는 문자열을 정의하겠다'라는 파이썬의 문법입니다.

 

따라서 주석이나 코드를 작성할 때 주석으로 어떤 변수에 주석 내용을 할당했는지 또 그로 인해서 주석 내용의 문자열만큼 메모리 용량이 점유되었는지 확인하고 주의를 기울여야 합니다.

 

#한 줄 주석입니다.
var=1
print("var:",var)

#여러
#줄로
#된
#주석입니다.

"""여러
줄로
된
주석입니다.
"""


del var
var = """주석 문장인데 값 설정이 될까요?"""
print("1)출력이 되면 값설정이 되었다는 의미입니다.\n\t",var)


del var
var = \
"""주석 문장인데 이런 형식도 값 설정이 될까요?"""
print("2)출력이 되면 값 설정이 되었다는 의미입니다.\n\t",var)


del var
var = #공식 주석으로 값 설정이 될까요?
print("3)출력이 되면 값 설정이 되었다는 의미입니다.\n\t",var)

위의 사진에서 2개의 적색박스와 녹색박스를 유심히 보셔야 합니다.

 

사진의 위쪽에 있는 첫번째 적색박스는 파이썬 공식 주석이 아닌 주석은 사실 문자열이라는 점이라는 것을 의미합니다.

그다음 녹색 박스는 코드 작성이 제대로 되지 않은 경우 변수에 주석 내용이 할당될 수 있음을 의미합니다.

마지막 두번째 적색 박스는 공식 주석으로는 값 설정이 안되니 코드 작성시 띄어쓰기나 줄바꿈에 유의해야 함을 의미합니다.

 

 

여기까지 파이썬 주석을 작성하는 방법을 알아 보았는데요.

세세한 주석 내용 작성 방법(a.k.a. 주석 내용 작성 가이드라인)은 각 팀별 의사소통이나 자동 문서화도구 문법에 따르니 이 포스트에서는 이 이상은 생략하도록 하겠습니다.