在Python中,`__doc__`属性是一个对象的文档字符串,用于描述该对象的作用。文档字符串通常用于提供函数、类或模块的功能说明、参数说明、返回值说明等。
1. 查看模块的文档字符串:
import mymodule
print(mymodule.__doc__)
2. 查看函数的文档字符串:
def myfunction():
"""This is a function docstring."""
pass
print(myfunction.__doc__)
3. 在模块中,如果当前模块是程序入口,可以使用`__doc__`属性输出模块的文档字符串:
if __name__ == "__main__":
print(__doc__)
文档字符串应该以三个双引号开始和结束,并应简洁明了地描述对象的作用。
需要注意的是,`__doc__`属性区分大小写,正确的属性名是`__doc__`,不是`_doc_`