什麼包含在Python Docstrings中？

Question

我想知道python docstrings包含哪些內容？就像如果我想記錄某個類一樣，我應該在該類的文檔字符串中編寫什麼東西？

Answer 1

根據PEP 257 -- Docstring Convention：

一類應該總結自己的行爲，並列出 公共方法和實例變量的文檔字符串。如果該類打算成爲子類別 ，並且具有用於子類的附加接口，則應該單獨列出此接口（在文檔字符串中）。類 構造函數應記錄在其文檔字符串中，其方法爲__init__ 。單獨的方法應該由他們自己的 docstring記錄。

如果一個類繼承了另一個類，並且其行爲主要是從該類繼承的 ，那麼它的docstring應該提到這個，並且 總結了這些差異。使用動詞「覆蓋」來指示 子類方法替代超類方法，並且不調用超類方法;使用動詞「extend」來表示子類 方法調用超類方法（除了它自己的行爲之外）。