python - 在 python 中使用字符串作为注释

Question

我目前正在阅读使用字符串作为注释的 python 代码。例如，这里有一个函数

def xyz(x):
    """This is a function that does a thing.
    Pretty cool, right?"""
    return 0

使用字符串作为注释有什么意义？看起来真的很奇怪。代码可以编译，但是非常困惑。

Answer 1

"""This is a function that does a thing.
Pretty cool, right?"""

这叫做 docstring . Python 文档字符串(或文档字符串)提供了一种将文档与 Python 模块、函数、类和方法相关联的便捷方式。

示例

可以使用 __doc__ 属性从解释器和 Python 程序访问文档字符串:

print(xyz.__doc__)

输出:

This is a function that does a thing.
    Pretty cool, right?

另一种用法:

from pydoc import help
print(help(xyz))

输出:

Help on function xyz in module __main__:

xyz(x)
    This is a function that does a thing.
    Pretty cool, right?