ITメモ
Make SiteMap Python[パイソン]




ドキュメントストリング(Document)



ドキュメントストリング(__doc__)とは


「ドキュメントストリング」とは、「モジュールの冒頭」「クラスの冒頭」「関数の先頭」に、
「三重クォート("""...""")」で記述したコメントのことを「ドキュメントストリング」という。

「ドキュメントストリング」は、「モジュールオブジェクト」「クラスオブジェクト」「関数オブジェクト」の「__doc__」アトリビュートで参照することが可能。

「ドキュメントストリング」は、対話モードの「help()」 でも参照可能。



サンプルコード


Sample.py
"""A Sample module"""
class SampleClass:
"""A Sample class"""
def SampleFunc(self, x, y):
"""A Sample function"""
return x + y


Sample2.py
import Sample
print Sample.__doc__ #=> A Sample module
print Sample.MyClass.__doc__ #=> A Sample class
print Sample.MyClass.myfunc.__doc__ #=> A Sample function