728x90
함수를 정의할 때 다른 사용자가 이용하기 편하게 함수 내용을 보여주는 것을 Docstring이라고 한다.
Docstring 내용은 함수 헤더 아래쪽 """ """ 사이에 입력한다.
Docstring은 help(함수명)으로 조회 가능하다.
아래는 작성 순서에 따른 내용
- Examples - 어떤 파라미터와 인수가 필요한지 정의
- Type Contract - 인수와 반환값의 타입 정의
- Header - 제목 정의
- Description - 함수 목적 정의
- Body - 코드 작성
- Test
728x90
'컴퓨터사이언스 > 파이썬 & 알고리즘' 카테고리의 다른 글
| 알고리즘 분석과 복잡도 표기법(Big-O) (0) | 2022.09.16 |
|---|---|
| 코딩테스트를 대비한 파이썬 자주 쓰이는 문법 모음 (0) | 2022.08.30 |
| Jupyter Notebook에서 Matplotlib 한글 깨짐 오류 영구적으로 수정하기 (0) | 2022.01.26 |
| pytrends API를 활용하여 인사이트 도출해보기 (0) | 2022.01.10 |
| Pycharm(파이참)에 Django(장고) 설치 (1) | 2022.01.01 |