Python學習筆記010——函數文檔字串

來源:互聯網
上載者:User

標籤:port   ring   img   test   help   es2017   模式   傳回值   輸入   

函數文檔字串documentation string (docstring)是在函數開頭,用來解釋其介面的字串。簡而言之:協助文檔

  1. 包含函數的基礎資訊
  2. 包含函數的功能簡介
  3. 包含每個形參的類型,使用等資訊
  4. 是介面設計的重要部分。
  5. 註:一個良好的介面不能簡單、清晰的表述該函數,則說明該函數還有最佳化改進的空間

函數文檔的使用

  1. 必須在函數的首行,經過驗證前面有注釋性說明是可以的,不過最好函數文檔出現在首行
  2. 使用三引號註解的多行字串(當然,也可以是一行),因三引號可以實現多行註解(展示)(‘‘‘ ‘‘‘) 或(""" """)
  3. 函數文檔的第一行一般概述函數的主要功能,第二行空,第三行詳細描述。

查看方式

  1. 在互動模式下可以使用help查看函數,協助文檔,該介面會跳到協助介面,需要輸入q退出介面
  2. 使用__doc__屬性查看,該方法的協助文檔文字直接顯示在互動介面上。

舉例說明

def test():    ‘‘‘        函數名:test        功能:測試        參數:無        傳回值:無    ‘‘‘    print("函數輸出成功")test()

 在互動模式下輸入

 >>> import day10 >>> help(day10.test)

最後在協助介面顯示如下 

 按q鍵退出

 

同樣在互動模式下出入

>>> import day10>>> print(day10.test.__doc__)        函數名:test        功能:測試        參數:無        傳回值:無    >>> 

如下

在其下直接顯示協助文檔。

 

Python學習筆記010——函數文檔字串

聯繫我們

該頁面正文內容均來源於網絡整理,並不代表阿里雲官方的觀點,該頁面所提到的產品和服務也與阿里云無關,如果該頁面內容對您造成了困擾,歡迎寫郵件給我們,收到郵件我們將在5個工作日內處理。

如果您發現本社區中有涉嫌抄襲的內容,歡迎發送郵件至: info-contact@alibabacloud.com 進行舉報並提供相關證據,工作人員會在 5 個工作天內聯絡您,一經查實,本站將立刻刪除涉嫌侵權內容。

A Free Trial That Lets You Build Big!

Start building with 50+ products and up to 12 months usage for Elastic Compute Service

  • Sales Support

    1 on 1 presale consultation

  • After-Sales Support

    24/7 Technical Support 6 Free Tickets per Quarter Faster Response

  • Alibaba Cloud offers highly flexible support services tailored to meet your exact needs.