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!