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

问题描述 投票:0回答:1

有两种方法可以在代码本身中记录模块,函数或类:commentsdocstrings

Docstrings更具功能性,因为它们可以通过help()函数访问,而comments只能在源代码中访问。

何时应该使用评论来代替docstrings

python comments docstring
1个回答
1
投票

Docstrings旨在从用户的角度解释函数的作用,以及它所采用和返回的值的类型和类型。

另一方面,注释位于源代码的主体中,只有那些实际阅读它的人才能看到,因此可以解释它是如何做的。

© www.soinside.com 2019 - 2024. All rights reserved.