Python docstring文檔字串__Python

來源:互聯網
上載者:User

使用DocStrings
Python有一個很奇妙的特性,稱為 文檔字串,它通常被簡稱為 docstrings 。DocStrings是一個重要的工具,由於它協助你的程式文檔更加簡單易懂,你應該盡量使用它。你甚至可以在程式啟動並執行時候,從函數恢複文檔字串。 使用DocStrings

例7.8 使用DocStrings

#!/usr/bin/python# Filename: func_doc.pydef printMax(x, y):'''Prints the maximum of two numbers.The two values must be integers.'''x = int(x) # convert to integers, if possibley = int(y)if x > y:print x, 'is maximum'else:print y, 'is maximum'printMax(3, 5)print printMax.__doc__
輸出

$ python func_doc.py
5 is maximum
Prints the maximum of two numbers.

The two values must be integers. 它如何工作

在函數的第一個邏輯行的字串是這個函數的 文檔字串 。注意,DocStrings也適用於模組和類,我們會在後面相應的章節學習它們。

文檔字串的慣例是一個多行字串,它的首行以大寫字母開始,句號結尾。第二行是空行,從第三行開始是詳細的描述。 強烈建議 你在你的函數中使用文檔字串時遵循這個慣例。

你可以使用__doc__(注意雙底線)調用printMax函數的文檔字串屬性(屬於函數的名稱)。請記住Python把 每一樣東西 都作為對象,包括這個函數。我們會在後面的類一章學習更多關於對象的知識。

如果你已經在Python中使用過help(),那麼你已經看到過DocStings的使用了。它所做的只是抓取函數的__doc__屬性,然後整潔地展示給你。你可以對上面這個函數嘗試一下——只是在你的程式中包括help(printMax)。記住按q退出help。

自動化工具也可以以同樣的方式從你的程式中提取文檔。因此,我 強烈建議 你對你所寫的任何正式函數編寫文檔字串。隨你的Python發行版附帶的pydoc命令,與help()類似地使用DocStrings。

聯繫我們

該頁面正文內容均來源於網絡整理,並不代表阿里雲官方的觀點,該頁面所提到的產品和服務也與阿里云無關,如果該頁面內容對您造成了困擾,歡迎寫郵件給我們,收到郵件我們將在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.