4.4 doc string 작성하고 사용하기
파이썬 doc string은 주석을 작성하거나 무료 온라인 도움말을 가져올 때 활용할 수 있다. 도움말은 pydoc 유틸리티를 사용하면 IDLE나 커맨드 라인에서 사용 가능하다.
doc string은 함수나 클래스 모두에서 등장할 수 있다. 비록 이 책에서 아직 클래스를 작성하는 방법을 소개하지 않았지만, 원칙은 똑같다. 다음 예시에서 doc string을 확인할 수 있는 함수를 살펴보겠다.
def quad(a, b, c):
'''Quadratic Formula function.
This function applies the Quadratic Formula
to determine the roots of x in a quadratic
equation of the form ax^2 + bx + c = 0.
'''
determin = (b * b - 4 * a * c) ** .5
x1 = (-b + determin) / (2 * a)
x2 = (-b - determin) / (2 * a)
return x1, x2