#5 [Seoul OSD] Docstring

Python 파이썬 연재 시리즈

2020/03/12 - [공부/Python] - #2 print() 함수 이용하기

2020/03/13 - [공부/Python] - #3 자료형과 문자열 기초

2020/07/31 - [공부/Python] - #4 [Seoul OSD] 함수 이용하기

본 게시물은 서울 오픈스퀘어 D (Seoul OSD) 강좌를 바탕으로 작성되었습니다. Seoul OSD 강좌에서는 아나콘다(Anaconda) 주피터노트북(jupyter notebook)으로 실습을 진행했으며 이에 따라 일부 코드가 일반적인 파이썬 환경과 다르게 동작할 수 있습니다.

 

Docstring의 풀네임(full name)은 Documentation string이다. 주요한 역할은 함수가 어떠하게 작동하는지 설명해주는 부분이라고 볼 수 있다.

이전 글에서 만들었던 모든 수의 합을 구하는 함수를 예를 들어 설명하면 다음과 같다.

def sum_all(*numbers): 
    '''이 함수는 사용자로부터 임의의 숫자들을 입력받아서 숫자들의 총합을 구하는 함수입니다.'''
    total = 0
    for number in numbers:
        total = total + number
    print(total)

작은따옴표 3개를 통해 작성한 글은 Docstring으로 분류되며 주피터노트북 기준으로 shift + tab으로 확인 가능하다.