如果你經(jīng)常閱讀Python的官方文檔，可以看到很多文檔都有示例代碼。比如re模塊就帶了很多示例代碼：

可以把這些示例代碼在Python的交互式環(huán)境下輸入并執(zhí)行，結(jié)果與文檔中的示例代碼顯示的一致。

這些代碼與其他說(shuō)明可以寫(xiě)在注釋中，然后，由一些工具來(lái)自動(dòng)生成文檔。既然這些代碼本身就可以粘貼出來(lái)直接運(yùn)行，那么，可不可以自動(dòng)執(zhí)行寫(xiě)在注釋中的這些代碼呢？

答案是肯定的。

當(dāng)我們編寫(xiě)注釋時(shí)，如果寫(xiě)上這樣的注釋：

無(wú)疑更明確地告訴函數(shù)的調(diào)用者該函數(shù)的期望輸入和輸出。

并且，Python內(nèi)置的“文檔測(cè)試”（doctest）模塊可以直接提取注釋中的代碼并執(zhí)行測(cè)試。

doctest嚴(yán)格按照Python交互式命令行的輸入和輸出來(lái)判斷測(cè)試結(jié)果是否正確。只有測(cè)試異常的時(shí)候，可以用...表示中間一大段煩人的輸出。

讓我們用doctest來(lái)測(cè)試上次編寫(xiě)的Dict類：

運(yùn)行python mydict2.py：

什么輸出也沒(méi)有。這說(shuō)明我們編寫(xiě)的doctest運(yùn)行都是正確的。如果程序有問(wèn)題，比如把__getattr__()方法注釋掉，再運(yùn)行就會(huì)報(bào)錯(cuò)：

注意到最后3行代碼。當(dāng)模塊正常導(dǎo)入時(shí)，doctest不會(huì)被執(zhí)行。只有在命令行直接運(yùn)行時(shí)，才執(zhí)行doctest。所以，不必?fù)?dān)心doctest會(huì)在非測(cè)試環(huán)境下執(zhí)行。

小結(jié)

doctest非常有用，不但可以用來(lái)測(cè)試，還可以直接作為示例代碼。通過(guò)某些文檔生成工具，就可以自動(dòng)把包含doctest的注釋提取出來(lái)。用戶看文檔的時(shí)候，同時(shí)也看到了doctest。