在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文档字符串（或docstrings）提供了一种将文档与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?

Answer 2

它们被称为docstrings，它们用于记录您的代码。像// instantiate angularLines and menu PowerMock.mockStatic(XmlParseUtility.class); EasyMock.expect(XmlParseUtility.createLinesToParse(menu)).andReturn(angularLines); PowerMock.replay(XmlParseUtility.class); // invoke test subject PowerMock.verify(XmlParseUtility.class); 这样的工具和内置函数也会检查文档字符串，因此它们不仅适用于代码的读者，也适用于代码的用户。