関数でできることの中には､ これまでにはなかったユニークなものがあり､ それは「doc string」と呼ばれています｡
どういうことか､ お見せしましょう｡
ここに関数があり､ それをtestと呼ぶことにします｡ testはaというパラメータを受け取り､
ここでaを表示することにします｡
役立たず｡
全く役に立たない｡
機能です｡
さて､ これをうまく実行しても､ testを呼び出してから､ まあ､ 感嘆符と言わなければならないので､ 何も起こりません｡
そして､ 私たちの機能が機能していることがおわかりいただけると思います｡
しかし､ Pythonの関数では､ 実はdoc stringというものを使うことができ､ それは次のようなものです｡
シングルコード､ シングルコード､ シングルコードとやっていくんですね｡
だから3人｡
そして､ もう一度一番下に､ シングルコード､ シングルコード､ シングルコード｡
このように､ 関数の冒頭部分と､ ここに関数に関する情報を追加することができます｡
例えば､ この関数はテストして印刷します｡
パー・アム・ア
さて､ ここからが面白いところです｡
ここでテストを実行し､ ブラケットをしたら､ それを見てください｡
編集者から情報を得る｡
この関数は､ doc文字列と呼ばれるものをテストして表示します｡
例えば､ 他の人がtest関数を使っている場合､ 将来､ 大きなアプリケーションを書くときに､
10行のコードだけでなく､ さまざまなファイルがあっても､ testが何をするか見つける代わりに､
その人が実際にコメントできるようにするのです｡
例えば､ lengthのようなものを使ってこれを実行すると､ doc文字列を使って関数に関する情報が得られることがわかりますが､
これはPythonに組み込まれているものです｡
別の見方をすれば
デボルブペイヤー環境というと､ 編集者が自動的にやってしまいそうなので､ 注意してください｡
しかし､ 実際には他にもいくつかの読み方があります｡
例えば､ Pythonにあらかじめ搭載されている､ 今まで見たことのないhelp関数ができるんです｡
そして､ 関数を呼び出さないようにします｡
これを実行したらテストでヘルプを呼びたいだけなんです｡
あれを見てください｡
テスト情報を得ることができる｡
この関数はパラメータをテストして表示するので､ ヘルプを使って関数が何をするのか調べることができ､
とてもとても便利です｡
もう一つの方法は､ マジックメソッドやダンダーメソッドと呼ばれるものを使うことです｡ これもコースの後半で説明します｡
その時はダブルアンダーでやっています｡
そうなんです､ 先生｡
そして､ 実行をクリックすると､ このように2つのアンダースコアが表示されます｡
さて､ ここで何か印刷しなければならないので､ 印刷しましょう｡
実行]をクリックして見てください｡
私も同じことを言われます｡
このドッグストリングは関数にコメントや定義を追加するのにとても便利で､ 例えばチームや同僚があなたの作った関数に出会ったとき､
Pythonファイルや複数のファイルを探さなくても､ その関数が何をするのかすぐに理解することができます｡
とても便利な機能です｡