該寫法根據Python的PEP 257文檔總結。
類的函數稱為方法（method），模塊里的函數稱為函數（function）

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

''' 遇到問題沒人解答？小編創建了一個Python學習交流QQ群：857662006 尋找有志同道合的小伙伴， 互幫互助,群里還有不錯的視頻學習教程和PDF電子書！ ''' 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...

總結

以上是生活随笔為你收集整理的Python中docstring文档的写法的全部內容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網站內容還不錯，歡迎將生活随笔推薦給好友。