1. 学ぶ
    2. /
  2. コース
    3. /
  3. Pythonで学ぶSoftware Engineeringの原則
Connected

演習

ドキュメンテーション文字列（docstring）を書く

docstring の利点について学んだところです。この演習では、Sphinx のようなドキュメンテーション生成ツールで利用できる docstring を実際に書いてみます。

提出する docstring は解答と「完全に」一致している必要があります。何度か不正解になる場合は、サンプルコードにリセットして、最初からやり直すことをおすすめします。

指示

100 XP
  • パラメータを記述する docstring の部分を完成させてください。
  • 返り値の説明を記述する docstring の部分を完成させてください。
  • docstring 内の使用例を完成させてください。