[파이썬] 파이썬의 주석 사용법

파이썬의 주석 사용법

파이썬에서 주석은 코드에 대한 설명을 추가하는 데 사용됩니다. 주석은 파이썬 인터프리터에 의해 무시되기 때문에 실행되지 않습니다. 주석은 코드를 다른 개발자나 나중에 볼 때 자신에게 설명하는 데 매우 중요합니다. 주석은 한 줄 주석과 여러 줄 주석(또는 블록 주석)으로 나눌 수 있습니다.

한 줄 주석

한 줄 주석은 # 기호를 사용하여 생성합니다. # 뒤에 오는 텍스트는 모두 주석으로 취급됩니다.

# 이것은 한 줄 주석입니다.
print("Hello, World!") # 이것도 주석입니다.

x = 5 # 변수 x에 5를 할당합니다.

여러 줄 주석

여러 줄 주석(또는 블록 주석)은 삼중 따옴표(''' 또는 """)를 사용하여 생성합니다. 시작하는 삼중 따옴표와 끝나는 삼중 따옴표 사이에 있는 모든 내용은 주석으로 처리됩니다. 공식적으로 파이썬에는 여러 줄 주석이라는 개념이 없지만, 문자열을 주석처럼 사용할 수 있습니다.

'''
이것은 여러 줄 주석입니다.
이 안에 있는 모든 내용은
파이썬 인터프리터에 의해 무시됩니다.
'''

"""
또 다른 예시입니다.
삼중 따옴표로 둘러싸인
모든 텍스트가 주석으로 취급됩니다.
"""

주석의 용도

주석은 코드에 대한 설명, 알고리즘 설명, 작업 항목, 버그 수정 등의 메모를 추가할 때 사용할 수 있습니다.

# 변수 x에 10을 할당합니다.
x = 10

# 다음 함수는 주어진 숫자의 제곱을 반환합니다.
def square(num):
    '''이 함수는 주어진 숫자의 제곱을 계산합니다.

    인수:
    num -- 제곱을 계산할 숫자

    반환값:
    주어진 숫자의 제곱값
    '''
    return num ** 2

# 함수 사용 예시
print(square(4)) # 출력: 16

주석 사용 사례

정리

#을 사용한 한 줄 주석은 코드의 간단한 설명을 추가하는 데 사용되었습니다. 삼중 따옴표를 사용한 블록은 함수의 동작을 자세히 설명하는 데 사용되었으며, 이런 방식으로 사용된 블록을 독스트링(docstring)이라고도 합니다. 독스트링은 함수, 클래스, 모듈의 첫 번째 문장으로 오며, 해당 객체에 대한 설명을 제공합니다. 파이썬에서는 이러한 독스트링을 자동으로 추출하여 문서화에 사용할 수 있습니다.