Pythonで関数を定義する方法【defの使い方とコメントの書き方】

プログラミングをするうえで関数を扱うことは必須です。Pythonでは組み込み関数と言われる便利なものが最初から備わっていますが、自分で関数を定義することもできます。

今回は関数を定義する方法からコメントの書き方などの基本的なルールを紹介していきます。

そもそも関数とは何か?組み込み関数とは?と思う方は以下の記事から確認できます。引数と戻り値の用語解説も確認しておきましょう。

関連記事

プログラミングの勉強での山場の一つであるPythonの関数の解説をしていきます。引数・戻り値の解説から組み込み関数一覧まで紹介しています。 関数とは? 関数とは入力値を処理してある値を出力する装置のことを言います。ブラックボッ[…]

Pythonの関数とは?

関数を定義する方法

関数を定義する構文は以下のようになります。Pythonでは戻り値(return文)が無くても関数として定義できます。

戻り値なし

以下の例では関数の仮引数がn、実行文にfor文とprint関数が書かれています。return文はありません。

このようにreturnがない場合の戻り値はNoneになります。ためしに関数の値を変数に代入してprint関数で出力すると以下のようにNoneとなります

1行目の「sample(3)」が実行されて0~2が出力されていますが、2行目の「print(x)」ではNoneが出力されています。

つまり、returnがないと変数に代入することができません。

戻り値あり

下の例では戻り値なしで紹介した関数に空のリストを追加しました。このリストの中にfor文でループさせた値を追加していきます。

今回はreturnにリストを指定しているので戻り値はリストになります。先ほどのようにNoneにはなっていません。

関数のコメント

コメントの書き方

プログラミングでは関数を作るだけでなく読みやすいものが好まれます。その助けになってくれるのがコメントです。

このコメントのことをドキュメンテーション文字列(docstring)と言います。defの次の行にコメントを書くことで関数の実行文をすべて読まなくても理解できます。

  • 1行ならコメントの’#’で書く
  • 複数行なら3連のクォート(”)で囲む
  • どういった処理をする関数なのかを書く

コメントを表示する方法

関数のコメント(ドキュメンテーション文字列)は書くだけではなく、その文字列を取得することもできます。以下のようにドキュメンテーション文字列を書いたときを見てみましょう。

関数名に「.__doc__」をつけるとprint関数で表示できます。

まとめ

関数を定義する方法とコメント(ドキュメンテーション文字列)について解説していきました。

return文の有無で戻り値が異なるところがもっとも注意するところです。関数の挙動が思うようにいかないときは戻り値のデータ型を確認してみましょう。

Pythonの関数に関する記事たち
5

当ブログではPython初心者が独学で習得するためのカリキュラムを公開中!

初心者がPythonを独学で習得できたロードマップはコチラ

Pythonで関数を定義する方法【defの使い方とコメントの書き方】
最新情報をチェックしよう!