목록docstring (1)

Devlog

파이썬 Docstring 작성법

파이썬에서 함수 혹은 클래스를 정의할 때 코드 그 자체만으로 의도가 분명히 드러나는 코드가 사실상 가장 훌륭한 코드이다. 하지만 어떤 때에는 키워드 매개변수들에 어떤 값을 넣어야 하며, 기본값이 존재하는지의 여부와 함수의 인풋과 아웃풋을 명확하게 표시하기 위해 문서화를 하는 것도 중요하다. 파이썬은 기본적으로 문서화를 위해 독스트링(docstring) 기능을 제공한다. 해당 독스트링을 통해 사용자에게 기능을 사용함에 있어 편의성을 제공할 수 있다. 독스트링은 어떻게 작성하며, 어떻게 불러올 수 있는지 파이썬 PEP 문서를 보고 간단히 알아보았다. https://peps.python.org/pep-0257/ PEP 257 – Docstring Conventions | peps.python.org PEP 2..
언어/Python 2023. 2. 13. 00:22
이전 Prev 1 Next 다음