読者です 読者をやめる 読者になる 読者になる

Screaming Loud

研究・プログラミングなど気づいたことをメモをしています

コメントのススメ

python プログラミング

プログラミングをするときにコメントアウトしてコードの可読性を上げるのは常識ですね.
Pythonのコメントは「#」ですが,実は"""hogehoge"""で書いたほうが良いことを知りました.
今まで知らなかったことが,恥ずかしい話なのですが・・・.

ではどうして"""hogeohoge"""で書いたほうが良いのでしょうか?

foo.py

 def function(a, b):
     """function(a, b) -> list"""

このように関数を書いたとします.

そこで対話形式において

>>import foo
>>help(function)

function(a,b)
    function(a, b) -> list

と表示させることができます.
いわゆるdocstringです.

参考URL:
PEP-JP 257