Python

[Python] Docstring

주댕이 2024. 1. 12. 17:15

# Docstring

  • 모듈, 함수, 클래스 또는 메서드 정의에서 첫 번째 문으로 나타나는 문자열 리터럴
  • 코드의 목적, 사용법 및 동작에 관한 문서화를 제공하는 데 사용한다.
  • 코드를 더 읽기 쉽게 만들고 사용자 및 개발자에게 유용한 정보를 제공한다.
  • 세 개의 따옴표로 둘러싸여 있으며, 정의문 바로 다음에 배치한다.
def add_numbers(a, b):
    """
    This function adds two numbers and returns the result.

    Parameters:
    a (int): The first number.
    b (int): The second number.

    Returns:
    int: The sum of the two numbers.
    """
    return a + b

print(add_numbers(1, 2))  # 3

print(add_numbers.__doc__)
#     This function adds two numbers and returns the result.
# 
#     Parameters:
#     a (int): The first number.
#     b (int): The second number.
# 
#     Returns:
#     int: The sum of the two numbers.
728x90

'Python' 카테고리의 다른 글

[Python] 가상 환경 사용하기  (2) 2024.01.16
[Python] 클래스 상속  (0) 2024.01.12
[Python] 리스트 컴프리헨션(List comprehension)  (0) 2024.01.12
[Python] break와 continue  (0) 2024.01.12
[Python] while 문  (0) 2024.01.12