파이썬 주석 처리 방법 : 한줄, 여러줄, 단축키(파이참, 주피터, 코랩)

파이썬 한줄 주석, 여러줄 주석과 단축키 정리

안녕하세요. 이번에는 아주 간단한 파이썬에서 주석을 처리하는 방법에

대해서 살펴보는 시간을 가져보도록 하겠습니다.

 

주석 처리 이유, 장점

먼저, 주석은 왜 필요할까요?

 

제가 구현한 코드를 다른 사람에게 보여주거나,

혹은 다른 사람의 코드를 제가 이해해야하거나

심지어는, 제가 예전에 구현했던 코드를 다시 보거나 하는 등의 상황에서

 

코드만 달랑 있으면 해당 클래스나 메소드가 무엇을 의미하는지, 변수의 의도와

사용되는 곳 등의 정보를 이해하기가 매우 난감한 경우가 많습니다.

 

따라서, 아래 코드처럼 함수의 정보, 변수의 의미 등을 알면 코드를 이해하기가

수월할 것입니다.

# 1부터 n까지의 수를 더하여 반환하는 함수
def sum_1_to_n(n):
    hap = 0 # 현재까지 합에 대한 정보를 저장하는 함수
    for i in range(1, n+1): # 1~n까지 순회
        hap += i # 해당 숫자 누적 덧셈
    return hap # 최종합 반환

물론, 모든 줄마다 일일이 주석을 달 필요는 없겠지만,

적당한 수준의 주석 정보는 코드 이해에 큰 도움을 줍니다.

 

주석처리의 가장 큰 장점은 코드 실행에 영향을 주지 않고 설명을 추가할 수

있다는 점입니다.

 

이제 파이썬에서 주석을 다는 여러 케이스에 대해서 정리해보겠습니다.

 

 

파이썬 한줄 주석 : # 붙이기

먼저, 가장 간단한 한줄 주석을 다는 방법입니다.

#을 붙이면 해당 줄의 # 이후 부분은 모두 주석처리되어 실행 결과에 반영되지 않습니다.

a = 0
b = 1
c = a # +b

# 주석 예시, 줄의 시작 부분에도 등장 가능
print(c) # 0 출력, 줄의 뒷 부분에 등장 예시, 세 번째 줄은 c = a 와 같은 결과

세 번째 줄은 +b 부분은 반영되지 않아,

실질적으로 c = a와 같은 코드라는 점을 쉽게 이해하실 수 있을 듯 합니다.

#이 있는 위치에 대해서는 크게 제약사항은 없습니다.

반응형

파이썬 여러줄 주석 : 3중 따옴표(''', """)

여러줄 주석처리는 여러줄 문자열을 작성하는 방식인 3중따옴표로

해당 부분을 지정해주시면 됩니다.

 

작은따옴표, 큰따옴표 여부는 상관 없으나,

주석이 시작되는 부분은 들여쓰기의 영향을 받는다는 점을 참고해주세요.

a = 0
b = 1

''' 여러줄 주석 처리 예시
a = 3
b = 4
'''

print(a+b) # 1 출력

    """ 유효한 들여쓰기가 아니라서 오류(여기서는 첫 부분부터 시작해야 함)
a = 3
b = 4
"""

아래쪽 주석은 위에 if, for, def 등 들여쓰기가 필요한 명령어가 나타나지 않은 상태로

들여쓰기가 진행되는 위치에서 시작되고 있으므로 오류가 발생합니다.

 

 

파이썬 주석 처리 단축키 : ctrl + /

여러 줄을 동시에 주석처리 하고 싶은 경우,

블록처리한 코드 부분에 ctrl + / 단축키를 입력해주시면 주석이 씌워졌다

풀렸다 하시는 것을 보실 수 있습니다.

 

파이참, 주피터 노트북, 코랩(Colab)의 경우에는 ctrl + / 단축키를 쓰시면 되며,

다른 일부 환경에서는 단축키가 다른 경우도 있습니다.

윗 부분처럼 블록을 진행하고 ctrl + / 을 눌러주시면

아래 부분처럼 코드 4줄에 동시에 주석이 처리된 것을 확인하실 수 있습니다.