Python中docstring文件的寫法

2022-03-02 22:54:09 字數 931 閱讀 3353

該寫法根據python的pep 257文件總結。

類的函式稱為方法(method),模組裡的函式稱為函式(function)

每乙個包,模組,類,函式,方法都應該包含文件,包括類的__init__方法

包的文件寫在__init__.py檔案中

文件有單行文件和多行文件

單行文件:

不要重複函式的宣告語句,例如:function(a, b) -> list

指明做什麼和返回什麼,例如do x and return a list.

使用三引號,方便換行

多行文件:

如果模組是乙個指令碼,也就是單檔案程式,模組的文件應該寫明指令碼的使用方法

模組的文件需要寫明包含的類,異常,函式

如果是包,在__init__.py中,寫明包裡面包含的模組,子包

如果是函式或類方法,應該寫明函式或方法的作用,引數,返回,***,異常和呼叫的限制等

如果是類,寫明類的行為,和例項引數,構造方法寫在__init__中

使用三引號,而且兩個三引號都應該單獨成行

單行例子:

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中 python中的 與

這一部分首先要理解python記憶體機制,python中萬物皆物件。對於不可變物件,改變了原來的值,其別名 變數名 繫結到了新值上面,id肯定會改變 對於可變物件,操作改變了值,id肯定會變,而 是本地操作,其值原地修改 對於 號操作,可變物件和不可變物件呼叫的都是 add 操作 對於 號操作,可變...

python中否定for 在python中否定函式

有沒有一種方法可以否定乙個函式,使它返回負數。在我的函式中,我有條件句,每個條件句都讓這個 烏龜 移動。有沒有一種方法可以否定這一點,所以烏龜的每乙個動作都是否定的。我說的是 狀況 在def ttinterpret program interpret program as a tinyturtle ...

python中雙重迴圈 加速Python中的雙迴圈

有沒有辦法加快從上一次迭代更新其值的雙迴圈?在 中 def calc n,m x 1.0 y 2.0 container np.zeros n,2 for i in range n for j in range m x np.random.gamma 3,1.0 y y 4 y np.random....