为什么在记录 python 时要使用注释？

Question

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

Docstrings 更实用，因为它们可以通过 help() 函数访问，而 comments 只能在源代码中访问。

什么时候应该使用注释代替 docstrings？

Answer 1

文档字符串旨在从用户的角度解释函数的作用，根据它采用的值的种类和类型以及returns。

另一方面，注释位于源代码的正文中，只有真正阅读它的人才能看到，因此可以解释如何它做了什么确实如此。