4. 文档字符串

什么是文档字符串

在模块、函数、类中，第一个没有赋值给任何变量的字符串称为文档字符串，此字符串会绑定在 __doc__ 属性上，供PyCharm的提示或 help() 函数使用。

help()函数

作用 - 启动内置的帮助系统（此函数主要在交互式中使用）。

说明

• 如果没有实参，解释器控制台里会启动交互式帮助系统。如果实参是一个字符串，则在模块、函数、类、方法、关键字或文档主题中搜索该字符串，并在控制台上打印帮助信息。
• 如果实参是其他任意对象，则会生成该对象的帮助页。

示例

# 此实例示意文档字符串的用法

import mymod
print(mymod.__doc__)
mymod.welcome('超人')
print(mymod.welcome.__doc__)
dog1 = mymod.Dog()
print(mymod.Dog.__doc__)
dog1.speak()
print(mymod.Dog.speak.__doc__)

用法：在交互执行模式下：

>>> help(mymod)

或

>>> help(mymod.Dog)

此时查看的就是文档字符串。