有两种方法可以在代码本身中记录模块,函数或类:comments
和docstrings
。
Docstrings
具有更多的功能,因为可以通过help()
函数访问它们,而comments
只能在源代码中访问。
什么时候应该使用注释代替docstrings
?
Docstrings旨在从用户的角度解释函数执行的功能,以及该函数执行和返回的值的类型和类型。
评论,而另一方面,在源代码中的身体之中,将只对那些实际阅读可见并因此用来解释如何它它做什么。
本文收集自互联网,转载请注明来源。
如有侵权,请联系 [email protected] 删除。
我来说两句