Python – docstring

測試環境為 CentOS 8 x86_64 (虛擬機)

在 function 的第一行可以使用一段字串(需使用 ”’ String ”’ 或是 “”” String “””)來描述該 function 的功能是什麼,這就是 docstring ,範例如下.

[root@localhost ~]# vi testfun.py
def testfun(n):
    '''
    This is a 
    docstring sample
    '''
    return n

print(testfun(1))
print(testfun.__doc__)

執行結果,透過 __doc__ attribute 會列出 docstring .

[root@localhost ~]# python3 testfun.py
1

    This is a
    docstring sample

上面範例可以直接透過 Python command 來執行,透過 ctrl+z 來跳出.

[root@localhost ~]# python3
Python 3.6.8 (default, Mar 25 2022, 11:15:52)
[GCC 8.5.0 20210514 (Red Hat 8.5.0-10)] on linux
Type "help", "copyright", "credits" or "license" for more information.
>>> def testfun(n):
...     '''
...     This is a
...     docstring sample
...     '''
...     return n
...
>>> print(testfun(1))
1
>>> print(testfun.__doc__)

    This is a
    docstring sample

>>>
[3]+  Stopped                 python3