在编写python文档时，为什么要使用注释？

Question

有两种方法可以在代码本身中记录模块，函数或类：comments和docstrings。

Docstrings具有更多功能，因为可以通过help()函数进行访问，而comments仅可以在源代码中进行访问。

何时应使用注释代替docstrings？

Answer 1

文档字符串旨在从用户的角度来解释函数的作用，包括它所获取和返回的值的类型和类型。

另一方面，

注释位于源代码的主体中，只有实际阅读它们的人员才能看到，并相应地用来解释如何做什么。