以程式設計方式訪問文件字串

文件字串 - 與常規註釋不同 - 儲存為它們所記錄的函式的屬性，這意味著你可以以程式設計方式訪問它們。

一個示例函式

def func():
    """This is a function that does nothing at all"""
    return

可以使用 __doc__ 屬性訪問 docstring：

print(func.__doc__)

這是一個什麼都不做的功能

help(func)

在模組 __main__ 中幫助函式 func：

func()

這是一個什麼都不做的功能

另一個例子功能

function.__doc__ 只是實際的 docstring 作為字串，而 help 函式提供有關函式的一般資訊，包括 docstring。這是一個更有用的例子：

def greet(name, greeting="Hello"):
    """Print a greeting to the user `name`

    Optional parameter `greeting` can change what they're greeted with."""
    
    print("{} {}".format(greeting, name))

help(greet)

在模組 __main__ 中幫助功能 greet：

greet(name, greeting='Hello')

向使用者列印問候語 name
可選引數 greeting 可以改變他們的歡迎。

文件字串優於常規評論的優點

在函式中放置沒有文件字串或常規註釋會使它不那麼有用。

def greet(name, greeting="Hello"):
    # Print a greeting to the user `name`
    # Optional parameter `greeting` can change what they're greeted with.
    
    print("{} {}".format(greeting, name))

print(greet.__doc__)

沒有

help(greet)

在模組 main 中幫助函式問候 ：

greet(name, greeting='Hello')