用于展示對(duì)類的解釋說(shuō)明文字,可以用三個(gè)引號(hào)括起來(lái)的字符串來(lái)定義文檔字符串:
class Student:
? ? """學(xué)生類有兩個(gè)屬性屹堰,name和score"""
? ? def __init__(self,name,score):
????????"""name應(yīng)該是一個(gè)字符串铣鹏,score應(yīng)該是一個(gè)列表"""
? ? ? ? self.name=name
? ? ? ? self.score=score
????def average(self):
? ? ? ? """計(jì)算平均分"""
? ? ? ? return sum(self.score)/len(self.score)
可以通過(guò).__doc__獲得doc信息:
xiaoming = Student('小明',[75.09,95.09])
print(xiaoming.__doc__)
# 輸出 學(xué)生類有兩個(gè)屬性滤奈,name和score
print(xiaoming.__init__.__doc__)??
# 輸出?name應(yīng)該是一個(gè)字符串晴楔,score應(yīng)該是一個(gè)列表
print(xiaoming.average.__doc__)?
# 輸出? 計(jì)算平均分
除了定義類顿苇,定義函數(shù)也可以使用__doc__:
def a(x,y):
? ? """計(jì)算兩個(gè)數(shù)的乘積……"""
????return x*y
print(a.__doc__)
#輸出?計(jì)算兩個(gè)數(shù)的乘積……