Pythonドキュメンテーション文字列
先週末からジワジワと始めているPython。本日覚えたのがドキュメンテーション文字列というやつ。
関数自体に関数の説明を持たせてしまうという機能だと思うのだけど、これがまた良く解らない。他の言語でプログラムを書くときは関数上部にコメントでその内容を書くことはあるけど、それを関数自体に組み込ませる意味がまだ解らない。
色々調べてみると、使い方が1つ。
REPL(Read Eval Print Loop)環境で、help()の引数に関数名を入れて実行すると、その関数のドキュメンテーションを表示することができるらしい。ん～まだ実感わかないな。
まぁコメントを書いておいて損することは滅多にないし、学習を進めていくうちにその意味が解ってくるでしょう。
