Docstring 작성하기
방금 docstring의 이점에 대해 배웠습니다. 이 연습에서는 Sphinx 같은 문서 생성기에서 활용할 수 있는 docstring을 직접 작성해 보겠습니다.
제출하는 docstring은 정답과 완전히 일치해야 합니다. 여러 번 틀린다면 샘플 코드를 새로 고치고 처음부터 다시 시작하는 것이 좋습니다.
이 연습은 강의의 일부입니다
Python으로 배우는 소프트웨어 공학 원칙
연습 안내
- 매개변수를 문서화하는 docstring 부분을 완성하세요.
- 반환값을 설명하는 docstring 부분을 완성하세요.
- docstring의 함수 사용 예제를 완성하세요.
실습형 인터랙티브 연습
이 예제를 이 샘플 코드를 완성하여 풀어보세요.
# Complete the function's docstring
def tokenize(text, regex=r'[a-zA-z]+'):
"""Split text into tokens using a regular expression
:____ text: text to be tokenized
:param ____: regular expression used to match tokens using re.findall
:____: a list of resulting tokens
>>> ____('the rain in spain')
____
"""
return re.findall(regex, text, flags=re.IGNORECASE)
# Print the docstring
help(tokenize)