如何描述模塊使用情況？

Question

當寫模塊的用法時，我包含哪些參數？例如，如果有一個模塊包含多個功能，我是否將所有輸入參數包含在<>？ 謝謝

Answer 1

爲每個函數提供一個docstring，它完整地描述了它的用法，包括它的參數。

爲每個類和模塊提供一個文檔字符串，它提供必要的概述以瞭解類或模塊的用法和用途。通常情況下，這將是一些關於它的作用，以及如何開始使用它，如果不明顯。