함수 문서화하기

파이썬함수를 문서화하려면 그 함수에 문서화 문자열(doc string)을 주면 됩니다.

문서화 문자열이 여러 줄이 아니라 하더라도, 관례에 따라 큰 따옴표 세 개를 사용

함수의 문서화 문자열(doc string) 정의

def build_connection_string(params):
    """매개변수 사전으로부터 접속 문자열을 구축한다.
    문자열을 돌려준다."""

def times2(n):
    """n이 매개변수로 주어지면 n*2를 반환"""
    return n * 2

def fact(n):
    """n의 계승을 반환.
       n의 계승을 재귀적으로 계산.
       음수인지, 스택오버플로우가 일어나는지 검사하지 않음.
       조심해서 사용할것!
    """
    if n in (0, 1):
        return 1
    else:
        return n * fact(n - 1)