shinoblog-manabu

Progate(プロゲート)を使って初歩の初歩からプログラミング勉強をはじめました。無料から有料バージョンへ以降しつつ、自分辞書として活用しています。なるべく私と同じ初心者目線を使い、各プログラミング内容を説明したいです。

【独学プログラマー】例外3 と ドキュメンテーション文字列

前回からの続き

「例外(エラー)を防ぐ方法」

 

注意点

except節内にて、

 

try節で定義された変数を使用しない事

try節で変数が定義されるよりも前に例外が発生する可能性があるため。

 

try節で定義された変数を使用した場合

新しい別の例外が発生する

 

変数定義前に例外が発生→その変数をexcept節で参照すると・・

 

f:id:shinoblog-manabu:20210512151710j:plain

新しいエラーが発生してしまう

 

 

f:id:shinoblog-manabu:20210512151752j:plain

このようにならない為にはどうすれば・・・。

 

 

ドキュメンテーション文字列

 

  1. 引数のデータ型を正しく伝えて関数を呼び出そう!

Q.

関数・関数内の引数を定義するとき、引数が特定のデータ型ではないと関数が正しく動作しない。ではどうするか?

 

A.下記画像をチェックする。

関数宣言の次の行にドキュメンテーション(docstring)というコメントを書く。

次に引数のデータ型について説明する。

 

ドキュメンテーション文字列に書くもの

  1. 関数の目的
  2. 必要な引数の種類

これら2つの説明を書く

 

 

f:id:shinoblog-manabu:20210512154109j:plain

関数の引数、引数の数、関数が返す値について書く

 

全ての人に分かりやすく読めるようにdocstingを書いていこう!

 

 

今回は以上になります。お疲れ様様でした。