Python如何快速從注釋產生文檔

作為一個標準的程式猿，為程式編寫說明文檔是一步必不可少的工作，如何才能寫的又好又快呢，下面我們就來詳細探討下吧。

今天將告訴大家一個簡單平時只要注意的小細節，就可以輕鬆產生注釋文檔，也可以檢查我們寫的類方法引用名稱是否重複有問題等。

一看別人專業的大牛們寫的文檔多牛多羨慕，不用擔心我們可以讓python為我們產生基本滿足的說明文檔，一來可以提高代碼整體閱讀性，二來可以將代碼的整體結構看著也更清晰，這樣在交接的時候可以省很多麻煩，其它同事在接手你工作的時候也不會一行行去問你這是什麼那是什麼的，因為注釋已經很直觀的表述了，在整合的時候可當說明文檔給客戶簡單說明(主要是給你BOSS看的).

那麼進入正題怎麼實現看下面我簡單的代碼格式，注意注釋的地方和函數名類名都是與__all__內相關聯的

#!/usr/bin/env python   # -*-coding:utf-8 -*-   '''      文檔快速產生注釋的方法介紹,首先我們要用到__all__屬性   在Py中使用為匯出__all__中的所有類、函數、變數成員等   在模組使用__all__屬性可避免相互引用時命名衝突   '''   __all__=['Login','check','Shop','upDateIt','findIt','deleteIt','createIt']   classLogin:   '''   測試注釋一可以寫上此類的作用說明等   例如此方法用來寫登入   '''   def__init__(self):   '''   初始化你要的參數說明   那麼登入可能要用到   使用者名稱username   密碼password   '''   pass   defcheck(self):   '''   協商你要實現的功能說明   功能也有很多例如驗證   判斷語句，驗證碼之類的   '''   pass   classShop:   '''   商品類所包含的屬性及方法   update改/更新   find尋找   delete刪除   create添加   '''   def__init__(self):   '''   初始化商品的價格、日期、分類等   '''   pass   defupDateIt(self):   '''   用來更新商品資訊   '''   pass   deffindIt(self):   '''   尋找商品資訊   '''   pass   defdeleteIt(self):   '''   刪除到期下架商品資訊   '''   pass   defcreateIt(self):   '''   建立新商品及上架資訊   '''   pass   if__name__=="__main__":   importpythonzhushi   printhelp(pythonzhushi)

這裡要強調說明下py的名字要和你當前工作的py名字一樣(我這裡建立的py名字就是pythonzhushi,最後匯入也是這名字)，因為下面的測試中import的匯入的是自身所以,im port 名稱 和Help(名稱)以及你的檔案名稱要一致才可以。為了更加直觀請看下面這圖：

當然還可以從其它檔案引用的方式匯入這裡用到python常用的匯入方式from從哪個目錄import匯入什麼檔案pythonzhushi

當然我這裡還是用圖片來展示以下：

是不是一目瞭然，這樣也可以匯入我們需要做的注釋文檔，help協助方法就是幫我們查看到此檔案中所包含的類，函數,的一個簡單協助文檔，類似於readme文檔的一個說明。最後來看看掩飾效果吧：

是不是簡單的列印出我們程式的說明文檔，後面步驟直接可以建一個文本把這個粘貼過去，就完成一個readme的文檔說明，經過測試有幾點注意是，想要寫#這種注釋不要寫到def放發內要寫到它的上面位置和裝飾器類似，相反三引號'''不要寫到def外面,這樣也是沒顯示效果的。大家趕緊去試試吧。感謝觀看。。