Документация String Stub, Python

Question

Я изучаю Python, потому что я думаю, что это удивительный и мощный язык, такой как C ++, perl или C #, но в то же время он действительно очень прост.Я использую Pycharm от JetBrains, и когда я определяю функцию, она просит меня добавить «заглушку строки документации», когда я нажимаю «да», она добавляет что-то вроде этого:

"""

"""

, поэтому полный код функциичто-то вроде этого:

def otherFunction(h, w):
    """

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

    return full_word

Я хотел бы знать, что означают эти ("" "" "") символы, Спасибо.

Answer 1

"" "" "" - escape-последовательность для строк, охватывающих несколько строк в python.

При правильном размещении после объявления функции или класса они предоставляют документацию для указанной функции / класса (они называются docstrings )

Answer 2

Тройные кавычки обозначают многострочную строку.Вы можете поместить любой текст там, чтобы описать функцию.Он может быть доступен даже из самой программы:

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

Answer 3

Они называются «строки документации» и предоставляют встроенную документацию для Python. PEP описывает их в целом, а в статье Википедии приводятся некоторые примеры.