python快速生成註釋文檔的方法

 今天將告訴大家一個簡單平時只要註意的小細節，就可以輕鬆生成註釋文檔，也可以檢查我們寫的類方法引用名稱是否重覆有問題等。一看別人專業的大牛們寫的文檔多牛多羡慕，不用擔心我們可以讓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
        '''
        pass

    def check(self):
        '''
        協商你要實現的功能說明
        功能也有很多例如驗證
        判斷語句，驗證碼之類的
        '''
        pass


class Shop:
    '''
    商品類所包含的屬性及方法
    update改/更新
    find查找
    delete刪除
    create添加
    '''

    def __init__(self):
        '''
        初始化商品的價格、日期、分類等
        '''
        pass

    def upDateIt(self):
        '''
        用來更新商品信息
        '''
        pass

    def findIt(self):
        '''
        查找商品信息
        '''
        pass

    def deleteIt(self):
        '''
        刪除過期下架商品信息
        '''
        pass

    def createIt(self):
        '''
        創建新商品及上架信息
        '''
        pass

if __name__=="__main__":
    import pythonzhushi
    print help(pythonzhushi)

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

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

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

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

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