Question

我正在学习Python，因为我认为它是一种非常强大且强大的语言，如C ++，perl或C＃，但同时真的很容易。我正在使用JetBrains的Pycharm，当我定义一个函数时，它要求我添加一个“Documentation String Stub”，当我点击yes时它会添加如下内容：

"""

"""

所以函数的完整代码是这样的：

def otherFunction(h, w):
    """

    """
    hello = h
    world = w
    full_word = h + ' ' + w

    return full_word

我想知道这些（“”“”“）符号的含义，谢谢。

Answer 1

“”“”“”是跨越python中几行的字符串的转义序列。

在函数或类声明之后，它们提供了所述函数/类的文档（它们被称为 docstrings ）

Answer 2

三重引号表示多行字符串。您可以在其中放置任何文本来描述该功能。它甚至可以从程序本身访问：

def thirdFunction():
    """
    All it does is printing its own docstring.
    Really.
    """
    print(thirdFunction.__doc__)

Answer 3

这些被称为'docstrings'，并为Python提供内联文档。 The PEP通常会对其进行描述，wikipedia article会提供一些示例。

Answer 4

您也可以将这些分配给变量！包括换行符：

>>> multi_line_str = """First line.
... Second line.
... Third line."""
>>> print(multi_line_str)
First line.
Second line.
Third line.

理论上一个简单的字符串也可以用作文档字符串。如果您为自己的换行符添加 \n，甚至是多行。：

>>> def somefunc():
...     'Single quote docstring line one.\nAnd line two!''
...     pass
...
>>> help(somefunc)
Help on function somefunc in module __main__:

somefunc()
    Single quote docstring line one.
    And line two!

但是三重引号...实际上三重双引号是标准约定！ See PEP237 也PEP8！

只是为了完整性。 :)

文档String Stub，Python

4 个答案: