【独学プログラマー】例外3 と ドキュメンテーション文字列
前回からの続き
「例外(エラー)を防ぐ方法」
注意点
except節内にて、
try節で定義された変数を使用しない事
try節で変数が定義されるよりも前に例外が発生する可能性があるため。
try節で定義された変数を使用した場合
新しい別の例外が発生する
例
変数定義前に例外が発生→その変数をexcept節で参照すると・・
ドキュメンテーション文字列
- 引数のデータ型を正しく伝えて関数を呼び出そう!
Q.
関数・関数内の引数を定義するとき、引数が特定のデータ型ではないと関数が正しく動作しない。ではどうするか?
A.下記画像をチェックする。
関数宣言の次の行にドキュメンテーション(docstring)というコメントを書く。
次に引数のデータ型について説明する。
ドキュメンテーション文字列に書くもの
- 関数の目的
- 必要な引数の種類
これら2つの説明を書く
全ての人に分かりやすく読めるようにdocstingを書いていこう!
今回は以上になります。お疲れ様様でした。