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

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

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

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

#!/usr/bin/env python# -*-coding:utf-8 -*-''' 文檔快速生成注釋的方法介紹,首先我們要用到__all__屬性在Py中使用為導出__all__中的所有類、函數、變量成員等在模塊使用__all__屬性可避免相互引用時命名沖突'''__all__ = ['Login', 'check', 'Shop', 'upDateIt', 'findIt', 'deleteIt', 'createIt']class Login:'''測試注釋一可以寫上此類的作用說明等例如此方法用來寫登錄'''def __init__(self):'''初始化你要的參數說明那么登錄可能要用到用戶名username密碼password'''passdef check(self):'''協商你要實現的功能說明功能也有很多例如驗證判斷語句，驗證碼之類的'''passclass Shop:'''商品類所包含的屬性及方法update改/更新find查找delete刪除create添加'''def __init__(self):'''初始化商品的價格、日期、分類等'''passdef upDateIt(self):'''用來更新商品信息'''passdef findIt(self):'''查找商品信息'''passdef deleteIt(self):'''刪除過期下架商品信息'''passdef createIt(self):'''創建新商品及上架信息'''passif __name__=="__main__":import pythonzhushiprint help(pythonzhushi)

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

當然還可以從其它文件引用的方式導入這里用到python常用的導入方式from從哪個目錄import導入什么文件pythonzhushi

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

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

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