파이썬에서 주석(Comment)이란?

파이썬에서 주석(Comment)이란?

파이썬에서 주석(Comment)은 코드에 대한 설명이나 메모를 작성할 때 사용되며, 프로그램 실행에 영향을 주지 않는 부분입니다. 주석은 코드의 가독성을 높이고, 다른 개발자 또는 미래의 자신이 코드의 의도를 쉽게 이해할 수 있도록 돕는 중요한 역할을 합니다. 파이썬에서는 한 줄 주석과 여러 줄 주석을 작성할 수 있습니다.

1. 한 줄 주석

한 줄 주석은 # 기호로 시작하며, 그 뒤에 오는 모든 내용은 주석으로 간주됩니다. 한 줄 주석은 코드의 특정 부분을 설명할 때 주로 사용됩니다.

예시:

# 이것은 한 줄 주석입니다.
x = 10  # 변수 x에 10을 할당

위 예시에서, # 뒤에 있는 내용은 주석으로 처리되며, 프로그램 실행에 영향을 미치지 않습니다.

2. 여러 줄 주석

파이썬에는 여러 줄 주석을 위한 전용 구문이 없지만, 여러 줄에 걸친 주석을 작성할 때는 연속된 한 줄 주석을 사용하거나, 문자열 리터럴을 이용하는 방법을 활용할 수 있습니다.

방법 1: 여러 줄 한 줄 주석

# 이 코드는
# 여러 줄에 걸쳐 작성된
# 주석입니다.
x = 20

한 줄 주석과 여러 줄 주석

 

방법 2: 문자열 리터럴을 사용한 여러 줄 주석

문자열 리터럴을 주석처럼 사용하여 여러 줄을 주석으로 만들 수 있습니다. 이 방법은 ''' 또는 """로 감싸서 여러 줄의 주석을 작성할 수 있지만, 실제로는 문자열 리터럴이지만, 실행되지 않는 위치에 있어 주석처럼 동작합니다.

"""
이 코드는 여러 줄 주석처럼 보이지만,
사실은 실행되지 않는 문자열 리터럴입니다.
"""
x = 30

 

이 방법은 주로 문서화 주석(예: 함수나 클래스의 설명)을 작성할 때 유용합니다.

3. 문서화 문자열 (Docstring)

Docstring은 주석과 유사하지만, 함수, 클래스, 모듈에 대한 설명을 제공하는 데 사용되는 특별한 형태의 주석입니다. 함수나 클래스 바로 아래에 문자열 리터럴(""" 또는 ''')을 사용해 작성하며, 파이썬의 문서화 도구에서 이를 읽을 수 있습니다.

예시:

def add(a, b):
    """
    두 수를 더하는 함수입니다.

    매개변수:
    a (int): 첫 번째 숫자
    b (int): 두 번째 숫자

    반환값:
    int: 두 수의 합
    """
    return a + b

 

이 docstring은 함수의 동작을 설명하며, help() 함수로 호출할 때 이 문서가 출력됩니다.

함수를 호출하면 출력되는 Docstring

요약

• 한 줄 주석: # 기호를 사용해 한 줄씩 주석을 작성.
• 여러 줄 주석: 여러 줄에 걸친 주석은 연속된 한 줄 주석이나 문자열 리터럴로 작성.
• 문서화 문자열(Docstring): 함수, 클래스, 모듈에 대한 설명을 위한 특별한 주석 형태로, """ 또는 '''로 감싸서 작성.

주석은 코드의 가독성과 유지 보수성을 높이는 중요한 도구입니다.