docstring 是指:
-
短字符串
- 单引号:
''
- 双引号:
" "
- 单引号:
-
跨行字符串
- 三单引号:
''' '''
- 三双引号:
""" """
- 三单引号:
比如如下的 Point.py 文件:
class Point:
' ... '
def __init__(self, x=0, y=0):
''' ...
...
'''
那么该如何查阅 docstring:
$ python -i point.py
>> import point
>> help(Point)
...
1. doc 级别
-
包级别的 doc:
__init__.py
文件,文件头部的""" """
三个双引号之间;>> import requests >> requests.__file__ # __init__.py 文件的路径 >> help(requests)
-
类级别的 doc:class 声明之后,
__init__
构造函数之前; -
函数级别;