docstring を書く
docstring のメリットについて学びました。この演習では、Sphinx などのドキュメント生成ツールで活用できる docstring の書き方を練習します。
なお、docstring の内容はモデル解答と完全に一致している必要があります。何度試してもうまくいかない場合は、サンプルコードをリセットして最初からやり直すことをおすすめします。
この演習はコースの一部です
Python におけるソフトウェアエンジニアリングの原則
演習の手順
- パラメータを説明する 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)