用于展示对类的解释说明文字,可以用三个引号括起来的字符串来定义文档字符串:
class Student:
"""学生类有两个属性,name和score"""
def __init__(self,name,score):
"""name应该是一个字符串,score应该是一个列表"""
self.name=name
self.score=score
def average(self):
"""计算平均分"""
return sum(self.score)/len(self.score)
可以通过.__doc__获得doc信息:
xiaoming = Student('小明',[75.09,95.09])
print(xiaoming.__doc__)
# 输出 学生类有两个属性,name和score
print(xiaoming.__init__.__doc__)
# 输出 name应该是一个字符串,score应该是一个列表
print(xiaoming.average.__doc__)
# 输出 计算平均分
除了定义类,定义函数也可以使用__doc__:
def a(x,y):
"""计算两个数的乘积……"""
return x*y
print(a.__doc__)
#输出 计算两个数的乘积……