Python——文檔字符串

文檔字符串docstrings

• 它本身就是一種註釋，不過是通過雙引號""包裹起來，通過三個雙引號包裹，可以寫多行。它提供了一種很方便的註釋方式，來協助關聯文檔。包、類、函數、方法都可以用使用文檔字符串。
• 可以通過訪問__doc__屬性，查看該對象的文檔字符串，或者調用help()函數來查看。上述兩種方法，只會顯示文檔字符串，不會顯示普通註釋。

1）help（）函數

 

>>> def age():
...   """I love China!"""
...   print('123')
...

>>> print(help(age))
Help on function age in module __main__:

age()
    I love China!

None

 

>>> age()
123

 

2）__doc__屬性

>>> print(age.__doc__)
I love China!