Python - doc string

- 도움말 작성 

>>> def quad(a, b, c) :
>>>     '''Quadratic Formula function.
>>>     
>>>     This function applies the Queadratic Fomula
>>>     to determine the root of ...
>>>     '''
>>> 
>>>     determin = (b*b - 4*a*c) ** .5
>>>     x1 = (-b + determin) / (2*a)
>>>     x2 = (-b - determin) / (2*a)
>>> 
>>>     return x1, x2
>>> 
>>> help(quad) # '''로 쌓인 문장이 나온다

 

[ 규칙 ]
- 3개의 따옴표로 둘러쌓여야 한다(''')
- 들여쓰기는 함수 도입부의 '첫 번째 레벨' 들여쓰기와 동일해야 한다.
- 첫번째 들여쓰기 이후 문장은 들여쓰기 규칙이 따로 없다.

[ pydoc ]
- 소스파일에 있는 모든 도움말 출력

>>> python -m pydoc test # test.py 모듈의 모든 함수 도움말 출력