[python 기초] docstring 문서화

Docstring이란❓

함수의 설명 작성

 

작성 방법 : 함수(혹은 클래스)  선언 직후 바로 아랫줄에 큰 따옴표 3개 혹은 작은 따옴표 3개로 작성

def echo(msg):
	"""
    echo func return its input argument
    The operation is:
    	1. print msg parameter
        2. return msg parameter
    param : msg : str
    return : str
    """
    
    print(msg)
    return msg

 

확인 방법

- echo?

- help(echo)

- print(echo.__doc__)

 

✔ Docstring Convention

https://www.python.org/dev/peps/pep-0257/