資訊專欄INFORMATION COLUMN
摘要：在中我們可以利用模塊名或者類名的方式來查看類或者函數(shù)的文檔。例如，我們添加了文檔測試內(nèi)容后如下所示由于我們寫了所以以上文檔測試只有在以入口文件執(zhí)行的時(shí)候才會(huì)進(jìn)行文檔測試。因此并不會(huì)在實(shí)際應(yīng)用在執(zhí)行文檔測試。
在python中我們可以利用help("模塊名")或者help(類名)的方式來查看類或者函數(shù)的文檔。但是它們是如何編寫的呢？
其實(shí)它們在類最前面或者方法的最前面用"""三個(gè)雙引號(hào)包裹了多行注釋。這些內(nèi)容就會(huì)被Python當(dāng)成幫助文檔。
那幫助文檔一般會(huì)寫什么內(nèi)容呢？主要包括以下內(nèi)容：
該類或者函數(shù)的主要作用
傳入的值和輸出的值
一些特殊情況的說明
文檔測試內(nèi)容
以上內(nèi)容是個(gè)人的總結(jié)，但是并沒有看到相關(guān)的資料。
我們來舉一個(gè)例子：
class Apple(object):
""" This is an Apple Class"""
def get_color(self):
"""
Get the Color of Apple.
get_color(self) -> str
"""
return "red"
在python terminal輸入
>>> from CallDemo import Apple >>> help(Apple)
Help on class Apple in module CallDemo: class Apple(__builtin__.object) | This is an Apple Class | | Methods defined here: | | get_color(self) | Get the Color of Apple. | get_color(self) -> str | | ---------------------------------------------------------------------- | Data descriptors defined here: | | __dict__ | dictionary for instance variables (if defined) | | __weakref__ | list of weak references to the object (if defined)利用doctest進(jìn)行文檔測試
我們在注釋中我們也可以doctest模塊進(jìn)行文檔測試。
例如，我們添加了文檔測試內(nèi)容后如下所示：
class Apple(object):
"""
This is an Apple Class
Example:
>>> apple = Apple()
>>> apple.get_color()
"red"
>>> apple.set_count(20)
>>> apple.get_count()
400
"""
def get_color(self):
"""
Get the Color of Apple.
get_color(self) -> str
"""
return "red"
def set_count(self, count):
self._count = count
def get_count(self):
return self._count * self._count
if __name__ == "__main__":
import doctest
doctest.testmod()
由于我們寫了
if __name__ == "__main__":
import doctest
doctest.testmod()
所以以上文檔測試只有在以入口文件執(zhí)行的時(shí)候才會(huì)進(jìn)行文檔測試。因此并不會(huì)在實(shí)際應(yīng)用在執(zhí)行文檔測試。
文章版權(quán)歸作者所有，未經(jīng)允許請(qǐng)勿轉(zhuǎn)載,若此文章存在違規(guī)行為，您可以聯(lián)系管理員刪除。
轉(zhuǎn)載請(qǐng)注明本文地址：http://m.specialneedsforspecialkids.com/yun/38322.html
摘要：軟件文檔或者源代碼文檔是指與軟件系統(tǒng)及其軟件工程過程有關(guān)聯(lián)的文本實(shí)體。而則認(rèn)為軟件文檔是被軟件工程師之間用作溝通交流的一種方式，溝通的信息主要是有關(guān)所開發(fā)的軟件系統(tǒng)。則強(qiáng)調(diào)文檔的權(quán)威性，他認(rèn)為文檔應(yīng)該提供對(duì)軟件系統(tǒng)的精確描述。 文檔，這個(gè)詞語在經(jīng)常在程序員的嘴里冒出來，有時(shí)候他們還經(jīng)常以文檔有沒有或者全不全為標(biāo)準(zhǔn)來衡量一個(gè)軟件項(xiàng)目是否高大上。那么，軟件中的文檔是什么呢？有什么要求呢？p...
摘要：同時(shí)，有多個(gè)類級(jí)別的靜態(tài)構(gòu)造函數(shù)的方法。這個(gè)累贅，無論如何，是被傳遞到每個(gè)單獨(dú)的對(duì)象構(gòu)造函數(shù)表達(dá)式中。我們可能只有幾個(gè)特定的擔(dān)憂，提供額外關(guān)鍵字參數(shù)給構(gòu)造函數(shù)。 注：原書作者 Steven F. Lott，原書名為 Mastering Object-oriented Python 沒有__init__()的無狀態(tài)對(duì)象 下面這個(gè)示例，是一個(gè)簡化去掉了__init__()的類。這是一個(gè)常見...
摘要：學(xué)習(xí)小組是由我發(fā)起的一個(gè)促進(jìn)新手互相學(xué)習(xí)互相幫助的組織。當(dāng)然如果你不喜歡英文，可以看我們的中文翻譯版本入門教程中文翻譯版。如果模板文件中有如下代碼那么渲染時(shí)就會(huì)循環(huán)渲染篇文章，并且也會(huì)被存儲(chǔ)在數(shù)據(jù)庫中文章的標(biāo)題取代。 本教程內(nèi)容已過時(shí)，更新版教程請(qǐng)?jiān)L問： django 博客開發(fā)入門教程。 本節(jié)是 Django Blog 項(xiàng)目的開篇，是?Django 學(xué)習(xí)小組的集體學(xué)習(xí)成果。Django...
摘要：在對(duì)象接口后包裝其實(shí)現(xiàn)的細(xì)節(jié)，從而隔離了代碼的修改對(duì)用戶產(chǎn)生的影響。類提供了一個(gè)新的本地作用域，最小化了變量名沖突。類其實(shí)并沒有結(jié)束，不過本講座到此對(duì)類暫告一段。 前面對(duì)類的有關(guān)內(nèi)容已經(jīng)描述不少了，其實(shí)話題遠(yuǎn)遠(yuǎn)沒有結(jié)束，不過對(duì)于初學(xué)者，掌握這些已經(jīng)算是入門，在以后的實(shí)踐中，還需要進(jìn)行體會(huì)和感悟。 這幾天和幾個(gè)朋友以各種途徑討論過OOP的相關(guān)問題，他們是：令狐蟲、Frank、晉劍、小馮...
摘要：原文地址近期在項(xiàng)目中使用到了相比較為齊全的工具這個(gè)非關(guān)系型數(shù)據(jù)庫客戶端只能通過與服務(wù)器端進(jìn)行交互于是有了為這個(gè)數(shù)據(jù)編寫個(gè)簡便的客戶端工具的想法。如果用戶沒有傳入對(duì)應(yīng)的參數(shù)則使用默認(rèn)的參數(shù)進(jìn)行綁定。 原文地址: http://52sox.com/use-python-write-a-memcached-cli/ 近期在項(xiàng)目中使用到了Memcached,相比redis較為齊全的工具,這個(gè)非...
閱讀 2998·2021-09-10 10:50
閱讀 3198·2019-08-30 14:19
閱讀 3526·2019-08-29 17:31
閱讀 3257·2019-08-29 16:43
閱讀 2203·2019-08-29 14:05
閱讀 2098·2019-08-29 13:17
閱讀 2055·2019-08-26 13:25
閱讀 1771·2019-08-26 12:20
