python docstring是什么意思

本篇文章給大家分享的是有關(guān)python docstring是什么意思，小編覺得挺實(shí)用的，因此分享給大家學(xué)習(xí)，希望大家閱讀完這篇文章后可以有所收獲，話不多說，跟著小編一起來看看吧。

Docstring是一種文檔字符串，用于解釋構(gòu)造的作用。我們?cè)诤瘮?shù)、類或方法中將它放在首位來描述其作用。我們用三個(gè)單引號(hào)或雙引號(hào)來聲明docstring。

>>> def sayhi():
 """
用該函數(shù)打印Hi
"""
 print("Hi") 
>>> sayhi()
Hi

要想獲取一個(gè)函數(shù)的docstring，我們使用它的_doc_屬性

>>> sayhi.__doc__
‘
  This function prints Hi
’

docstring，不僅可以編寫代碼，同時(shí)也能寫出文檔，保持代碼和文檔的一致。

docstring說白了就是一堆代碼中的注釋。

Python的docstring可以通過help函數(shù)直接輸出一份有格式的文檔。

編寫test.py

def printMax(x, y):
    '''Prints the maximum of two numbers.
    The two values must be integers.'''
    x = int(x) # convert to integers, if possible
    y = int(y)
    if x > y:
         print (x, 'is maximum')
    else:
         print (y, 'is maximum')
printMax(3, 5)
print (printMax.__doc__)

命令行輸入 help(test)

import test
5 is maximum
Prints the maximum of two numbers.
    The two values must be integers.
help(test)
Help on module test:
NAME
    test - Created on Sat Jun  2 19:05:08 2018
DESCRIPTION
    @author: linzhiwei02
FUNCTIONS
    printMax(x, y)
        Prints the maximum of two numbers.
        The two values must be integers.
FILE
    /Users/linzhiwei02/Desktop/test.py

以上就是python docstring是什么意思，小編相信有部分知識(shí)點(diǎn)可能是我們?nèi)粘９ぷ鲿?huì)見到或用到的。希望你能通過這篇文章學(xué)到更多知識(shí)。更多詳情敬請(qǐng)關(guān)注億速云行業(yè)資訊頻道。