함수 선언부에 이 doc string이 입력되면 IDLE에서 다음과 같이 도움말을 볼 수 있다.
>>> help(quad)
Help on function quad in module __main__:
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.
doc string을 작성하려면 몇 가지 규칙을 따라야 한다.
• doc string은 함수 이름을 선언하고 나서 바로 작성되어야 한다.
• 3개-따옴표 기능을 적용한 리터럴 문자열이어야 한다(실제로 어떤 스타일의 따옴표를 사용할 수 있으나, 여러 줄을 작성하기 위해 리터럴 따옴표7가 필요하다).
• doc string의 들여쓰기는 함수 도입부의 ‘첫 번째 레벨’ 들여쓰기와 동일해야 한다. 가령 함수 이름 선언 후 아래 줄 코드의 들여쓰기가 빈칸 4개로 되어 있다면 doc string의 시작도 빈칸 4개로 들여쓰기가 되어야 한다.
• doc string의 하위 줄들은 문자열이 리터럴 문자열이기 때문에 들여쓰기를 원하는 대로 할 수 있다. 하위 줄들을 왼쪽에 붙여서 작성하거나 doc string을 시작할 때 사용한 들여쓰기 방식을 계속 사용해도 된다. 두 경우 모두 파이썬 온라인 도움말은 보기 좋게 정렬된다.
7 역주 ''' ''' 혹은 """ """