什么是文档字符串
文档字符串使用详解
文档字符串
在Python中所特有的特性,在函数开头的地方,加上一行说明性文字,那么这行说明性文字我们就将其称为
文档字符串。
格式:
1.在定义函数第一行
2.开头结尾都是三引号
3.第一行:直接运行结果描述;
第二行:空一行;
第三行:函数详细信息。
#-*-coding:utf-8-*-
__author__ = 'allen'
#文档字符串
def d(i,j):
'''这个函数实现一个乘法运算。 #直接描述运行结果
---空一行---
函数会返回一个乘法运算的结果。''' #详细描述函数
k=i*j
return k
>>>print(d.__doc__)
>>>help(d)
>>> help(len)
Help on built-in function len in module __builtin__:
len(...)
len(object) -> integer #直接描述运行结果
Return the number of items of a sequence or collection. #详细描述函数
>>> print len.__doc__
len(object) -> integer
Return the number of items of a sequence or collection.
>>>