docstring은 코드의 문서화에 도움이 되는 문자열이다.
모듈 파일 처음이나 함수, 클래스 선언 다음 라인에
쌍따옴표 혹은 작은따옴표 세개를 사용해 docstring을 작성한다 (""" 내용 """)
이 내용에는 함수, 클래스, 모듈의 목적과 이를 이용할 때 필요한 세부 정보들을 담는 것이 관례이다.
docstring 사용이 필수적인 것은 아니지만 작성해두면 다른 사람이 사용할 때 이해를 돕는다.
help() 함수를 사용해 docstring을 확인할 수 있다.
'Python > Python 기초' 카테고리의 다른 글
| Python datetime 모듈을 이용해 날짜 다루기 (0) | 2022.11.22 |
|---|---|
| Python 라이브러리(Library) 활용하기 - random (0) | 2022.11.22 |
| Python 람다 표현식(Lambda expression) (0) | 2022.11.21 |
| Python 함수 매개변수의 기본 값 설정 - Default parameter (0) | 2022.11.21 |
| Python 함수(Function) 만들기 (0) | 2022.11.21 |