python : docstring

가독성 좋은 코드 작성하기

코드 문서화는 중요하다.

DOCUMENTATION STRING를 줄여서 docstring 이라 한다.

보통 ''' ''' 사이에 작성하며 이 사이에 나오는 모든 문자열(줄바꿈, 공백, 따옴표 등등) 은 하나의 docstring으로 간주된다. docstring 은 반드시 함수 본문내에서 처음으로 정의되는 객체여야 하며 코드상으로 함수 선언 바로 다음 줄에 써 줘야 한다. 

파이썬에서의 docstring은 단순한 주석이 아니다.

docstring은 함수의 어트리뷰트 가운데 하나이며 런타임 시에 호출 할 수 있다.

많은 파이썬 통합개발환경 들이 docstring 을 적극 활용한다. 특정 함수 이름을 타이핑 하기 시작하면 툴팁으로 함수의 docstring을 보여주기도 한다.