더북(TheBook)

코드 스타일을 좋게 하기 위해 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.
    '''

스타일 가이드라인에서 제안하듯이 함수 선언 후 함수의 간략한 요약을 넣어서 1줄을 띄고 상세한 설명을 넣는 것을 권장한다.

커맨드 라인에서 파이썬을 실행할 때 앞서 본 온라인 도움말을 pydoc 유틸리티로 사용할 수 있다. 가령 queens.py 모듈의 도움말을 보고 싶다고 해 보자. pydoc 유틸리티는 모든 함수의 도움말 요약을 출력해 준다. 이런 경우 모듈 이름의 확장자 ‘py’는 입력하지 않으니 주의하자.

> python -m pydoc queens
신간 소식 구독하기
뉴스레터에 가입하시고 이메일로 신간 소식을 받아 보세요.