삐닭 블로그

[python] docstring과 annotation

파이썬 코드안에 직접 문서화 하는 방법을 정리한다. 여기서 문서화라고 하는 것은 코드에 주석을 추가하는 것과는 다르다.코드에는 가능한 적은 주석을 갖는 것을 목표로 해야 한다. 좋은 코드는 코드 자체가 문서화되어 있기 때문이다.주석이 아닌 의미 있는 함수나 객체, 변수명을 사용하는 것과 같은 방법으로 말이다. 그렇다면 파이썬에서 주석이 아닌 코드 문서화는 어떻게 할 수 있을까?바로 docstring, annotation을 통해서다. docstringdocstring은 소스 코드에 포함된 문서이다. 이것은 기본적으로 리터럴 문자열이며 문서이다. 이유가 아닌 설명이다.docstring은 모듈, 클래스, 메서드 또는 함수에 대해 문서를 제공한다. 전체적인 관점에서 해당 컴포넌트가 어떻게 설계되었는지 힌트를 줄..