[python] 파이썬 주석 (한줄 주석, 여러줄 주석, 단축키, 오류위험)

안녕하세요. BlockDMask 입니다.

오늘은 파이썬의 주석에 대해서 이야기 해보려합니다. 주석에는 한줄 주석이 있고 여러줄 주석이 있습니다.

상황에 맞게 본인의 기호에 맞게 주석을 사용하면 됩니다.

혹시 그거 아시나요? 파이썬의 일부 주석은 들여쓰기를 맞춰야하는것을요.

파이참에서 컴파일을 하는데 주석때문에 안되는 경우가 있어서, 저같이 몰라서 헤매지 마시라고 이렇게 글을 작성해 봅니다.

그럼 파이참 주석에 관해서 시작해보겠습니다.

<목차>

1. 파이썬 주석의 종류

2. 파이참 주석 단축키, 파이썬 IDLE 주석 단축키,  vscode 주석 단축키

3. 파이썬 주석 사용시 주의사항 (주석에 들여쓰기를 하라고?)

1. 파이썬 주석의 종류

▶ 한줄 주석 : 샾(#)

파이썬에서는 한줄 주석을 달때는 #을 사용합니다. 아래 코드를 보시죠

1) 아무것도 없는 줄에 주석 달기

# 파이썬 한줄 주석 예제1
def juseok():
    print("주석 예제. BlockDMask")

보통은 #하고 스페이스로 한칸을 띄운 후에 글을 작성합니다. (파이참 IDE에서 그렇게 추천을 하네요)

2) 문장의 끝에 주석 달기

def juseok():
    print("주석 예제. BlockDMask") # 이것이 한줄 주석2 입니다.

▶ 여러줄 주석 : 큰따옴표 3개, 작은따옴표 3개

여러줄 주석은 두가지 방법으로 사용이 가능합니다.

1) 큰 따옴표 3개 연속으로 """ ~ """

def juseok():
    print("주석 예제. BlockDMask")
"""
첫 큰 따옴표 세개는 주석의 시작을 나타냅니다.
이렇게 자유롭게 주석을 작성한 후에 
주석이 끝난 부분에 아래처럼 큰 따옴표 세개를 다시 작성하면
주석의 끝을 나타내게 됩니다.
"""
a = 3 # 그냥 코드1
b = 4 # 그냥 코드2

이렇게 코드와 코드 사이에 주석을 작성할 수 있습니다.

2) 작은 따옴표 3개 연속으로 ''' ~ '''

while True:
    '''
    이 프로그램은 이렇고 저렇고 한 프로그램입니다.
    사용하실때는 출처를 남겨주세요
    설명설명설명~~
    '''
    print("=" * 30)  # "="를 30개 출력

2. 주석 단축키 (파이참, 파이썬 IDLE, vscode)

주석을 다는 단축키와 제거하는 단축키가 다른 경우가 있지만, 대부분은 동일한 단축키를 사용합니다.

보통 달려있는 주석에 같은 단축키를 입력하면 주석이 해제되고, 

주석이 없는 곳에서 주석 단축키를 사용하면 주석이 달리는 그러한 로직으로 돌아가게 됩니다.

▶ 파이참, vscode, vs 등 대부분 idle에서의 주석 단축키

Window : CTRL + /

Mac OS : Command + /

▶ 파이썬 IDLE 주석 단축키

주석 생성 : ALT + 3 

주석 제거 : ALT + 4

▶ 명령어로 여러줄 주석 달기

보통 여러줄 주석 """, ''' 을 사용하지 않고 단축키를 이용해서 원하는 코드를 드래그 한 후 명령어를 입력해서 주석을 달곤 합니다.

이렇게 소스코드가 존재하는데 이 소스코드를 전체 한번에 주석 처리 해야하는 상황이라 가정해볼게요

def addNum(a, b):
    print(f"{a} + {b} = {a + b}")

a = 10
b = 20
addNum(a, b)

이 소스코드를 드래그 합니다.

그후에 command + / , ctrl + / 등 주석 명령어를 입력합니다.

# def addNum(a, b):
#     print(f"{a} + {b} = {a + b}")
# 
# a = 10
# b = 20
# addNum(a, b)

이런식으로 한줄 짜리 주석으로 모두 주석처리 되는것을 볼 수 있습니다. 

주석해제는 주석 되어있는 줄에 커서를 두거나, 많은 줄인 경우 드래그를 한 후에 다시 주석 명령어를 입력하면 됩니다.

3. 파이썬 주석 사용시 주의사항

제가 공부했던 C#, C언어, C++같은 경우에는 주석의 위치나 들여쓰기등 주석은 아무곳에서나 사용하면 되었었는데요. (문장 사이 제외)

파이참의 주석은 좀 달랐습니다.

▶ 파이썬 주석의 특징, 주의할점

눈치가 빠르신 분들은 제가 1번 주석의 종류에서 작은따옴표로 예제를 든 부분을 보시고 땋 캐치 하셨을 수도 있습니다.

아니 그렇다고 위에 다시 가지 않으셔도 됩니다. 아래에서 다른 예제로 보여드리겠습니다. :)

파이썬 주석은.... "들여쓰기"를 해주어야합니다.

무슨 뜻인가 하면 파이썬은 들여쓰기로 if문의 끝, 함수의 끝 등 범위를 인식하게 되는데요, 주석도 마찬가지로 들여쓰기로 어느 함수의 주석인지 구분을 하게 됩니다.

아래 예제들을 보시죠.

class juseokExample:
'''
파이썬 주석은 들여쓰기를 잘 맞춰주어야 합니다. 이런경우 에러남
'''
    def __init__(self):
        a = 10
        b = 20

이런식으로 주석을 달려고 하면 IDE에서 IndentationError: expected an indented block 이라는 에러를 뱉습니다.

그렇기 때문에 들여쓰기로 맞추어서 아래처럼 이쁘게 주석을 달아주어야합니다.

class juseokExample:
    '''
    파이썬 주석은 들여쓰기를 잘 맞춰주어야 합니다. 이렇게 들여쓰기 맞춰주기
    '''
    def __init__(self):
        a = 10
        b = 20

이상으로 파이썬 주석에 대해서 알아보았습니다. 감사합니다.