함수 문서화(Documentation)

함수 문서화(Documentation)

함수를 작성할 때는 해당 함수의 목적, 매개변수, 반환값 등을 명확히 문서화하는 것이 좋습니다.

독스트링(Docstring)

파이썬에서는 함수의 첫 부분에 세 개의 따옴표("""...""")로 둘러싸인 문자열(독스트링)을 사용하여 함수를 문서화합니다.

def 사각형_넓이(가로, 세로):
    """
    사각형의 넓이를 계산하는 함수
    
    매개변수:
        가로 (float): 사각형의 가로 길이
        세로 (float): 사각형의 세로 길이
    
    반환값:
        float: 사각형의 넓이
    
    예시:
        >>> 사각형_넓이(5, 3)
        15.0
    """
    return 가로 * 세로

# help() 함수를 사용하여 독스트링 확인
help(사각형_넓이)

PEP 257 스타일 가이드

파이썬의 공식 스타일 가이드인 PEP 257에서는 다음과 같은 독스트링 작성 규칙을 제시합니다:

1. 첫 줄은 함수의 목적을 간결하게 설명합니다.
2. 첫 줄 뒤에는 빈 줄을 두어 구분합니다.
3. 그 다음 줄부터 자세한 설명, 매개변수, 반환값 등을 기술합니다.