該寫(xiě)法根據(jù)Python的PEP 257文檔總結(jié)。
類的函數(shù)稱為方法（method），模塊里的函數(shù)稱為函數(shù)（function）

每一個(gè)包，模塊，類，函數(shù)，方法都應(yīng)該包含文檔，包括類的__init__方法
包的文檔寫(xiě)在__init__.py文件中
文檔有單行文檔和多行文檔
單行文檔：
不要重復(fù)函數(shù)的聲明語(yǔ)句，例如：function(a, b) -> list
指明做什么和返回什么，例如Do X and return a list.
使用三引號(hào)，方便換行
多行文檔：
如果模塊是一個(gè)腳本，也就是單文件程序，模塊的文檔應(yīng)該寫(xiě)明腳本的使用方法
模塊的文檔需要寫(xiě)明包含的類，異常，函數(shù)
如果是包，在__init__.py中，寫(xiě)明包里面包含的模塊，子包
如果是函數(shù)或類方法，應(yīng)該寫(xiě)明函數(shù)或方法的作用，參數(shù)，返回，副作用，異常和調(diào)用的限制等
如果是類，寫(xiě)明類的行為，和實(shí)例參數(shù)，構(gòu)造方法寫(xiě)在__init__中
使用三引號(hào)，而且兩個(gè)三引號(hào)都應(yīng)該單獨(dú)成行
單行例子：

''' 遇到問(wèn)題沒(méi)人解答？小編創(chuàng)建了一個(gè)Python學(xué)習(xí)交流QQ群：857662006 尋找有志同道合的小伙伴， 互幫互助,群里還有不錯(cuò)的視頻學(xué)習(xí)教程和PDF電子書(shū)！ ''' def function(a, b):"""Do X and return a list."""

多行例子：

def complex(real=0.0, imag=0.0):"""Form a complex number.Keyword arguments:real -- the real part (default 0.0)imag -- the imaginary part (default 0.0)"""if imag == 0.0 and real == 0.0:return complex_zero...

總結(jié)

以上是生活随笔為你收集整理的Python中docstring文档的写法的全部?jī)?nèi)容，希望文章能夠幫你解決所遇到的問(wèn)題。

如果覺(jué)得生活随笔網(wǎng)站內(nèi)容還不錯(cuò)，歡迎將生活随笔推薦給好友。