有两种方法可以在代码本身中记录模块,函数或类:comments和docstrings。
comments
docstrings
Docstrings更具功能性,因为它们可以通过help()函数访问,而comments只能在源代码中访问。
Docstrings
help()
何时应该使用评论来代替docstrings?
Docstrings旨在从用户的角度解释函数的作用,以及它所采用和返回的值的类型和类型。
另一方面,注释位于源代码的主体中,只有那些实际阅读它的人才能看到,因此可以解释它是如何做的。