[파이썬] 파이썬 주석의 종류

파이썬 주석의 종류

파이썬에서 주석은 코드 내에서 설명이나 메모를 추가하는 데 사용됩니다. 주석은 코드 실행에 영향을 미치지 않으며, 주로 코드의 가독성을 높이고, 나중에 코드의 의미를 쉽게 이해할 수 있도록 돕는 역할을 합니다. 파이썬에서는 주석을 작성하는 방법이 몇 가지 있습니다.

1. 한 줄 주석 (Single-line Comment)

한 줄 주석은 # 기호를 사용하여 작성됩니다. # 기호 뒤에 작성된 모든 내용은 주석으로 처리되어 파이썬 인터프리터에 의해 무시됩니다.

# 이것은 한 줄 주석입니다
print("Hello, world!")  # 코드 옆에 주석을 작성할 수도 있습니다

2. 여러 줄 주석 (Multi-line Comment)

파이썬에는 특정하게 여러 줄 주석을 작성하는 문법은 없습니다. 하지만, 여러 줄의 주석을 작성할 때는 각 줄에 #를 붙여서 주석을 작성하거나, 문자열을 활용하는 방법이 있습니다.

방법 1: 여러 줄에 걸쳐 # 사용하기

# 이 코드는
# 여러 줄에 걸친
# 주석입니다
print("Hello, world!")

여러 줄 주석 적용

방법 2: 문자열을 활용하여 여러 줄 주석처럼 사용하기

문자열 리터럴을 사용하여 여러 줄 주석을 작성하는 방법도 있습니다. 주로 """ 또는 '''로 문자열을 감싸서 사용하며, 이는 실제로는 문자열 리터럴이지만, 아무 곳에도 할당되지 않으면 주석처럼 사용됩니다.

"""
이것은 여러 줄 주석처럼 보이지만,
사실은 문자열 리터럴입니다.
코드에서 실행되지 않지만, 
문서화나 설명을 위해 사용됩니다.
"""
print("Hello, world!")

이 방법은 종종 함수나 클래스의 문서화 문자열(docstring)로 사용되며, 실제 주석으로 사용되기보다는 문서화를 위한 설명을 작성할 때 주로 사용됩니다.

3. 문서화 문자열 (Docstring)

문서화 문자열은 함수, 클래스, 모듈 등을 설명하기 위해 사용하는 문자열입니다. 이 문자열은 함수나 클래스 정의의 첫 번째 부분에 위치하며, """ 또는 '''로 감싸서 작성합니다.

def greet(name):
    """
    이 함수는 주어진 이름을 인사합니다.
    :param name: 인사할 사람의 이름
    :return: None
    """
    print(f"Hello, {name}!")

문서화 문자열 주석

 

이처럼 문서화 문자열을 사용하면 코드의 기능을 설명할 수 있고, 이는 help() 함수를 통해 조회할 수도 있습니다.

정리

• 한 줄 주석: #을 사용하여 한 줄 주석을 작성합니다.
• 여러 줄 주석: 각 줄에 #을 붙이거나, 문자열 리터럴(""" 또는 ''')을 사용하여 여러 줄의 설명을 작성할 수 있습니다.
• 문서화 문자열 (Docstring): 함수, 클래스, 모듈 등을 설명하기 위해 사용되며, """ 또는 '''로 감싸서 작성합니다.

이러한 주석 기능을 활용하여 코드의 가독성을 높이고, 나중에 코드를 수정하거나 이해하기 쉽게 만드세요.