如何描述模块使用情况？

Question

当写模块的用法时，我包含哪些参数？例如，如果有一个模块包含多个功能，我是否将所有输入参数包含在<>？ 谢谢

Answer 1

为每个函数提供一个docstring，它完整地描述了它的用法，包括它的参数。

为每个类和模块提供一个文档字符串，它提供必要的概述以了解类或模块的用法和用途。通常情况下，这将是一些关于它的作用，以及如何开始使用它，如果不明显。