今天將告訴大家一個簡單平時只要注意的小細節，就可以輕鬆生成註釋文件，也可以檢查我們寫的類方法引用名稱是否重複有問題等。一看別人專業的大牛們寫的文件多牛多羨慕，不用擔心我們可以讓python為我們生成基本滿足的說明文件，一來可以提高程式碼整體閱讀性，二來可以將程式碼的整體結構看著也更清晰，這樣在交接的時候可以省很多麻煩，其它同事在接手你工作的時候也不會一行行去問你這是什麼那是什麼的，因為註釋已經很直觀的表述了，在整合的時候可當說明文件給客戶簡單說明(主要是給你BOSS看的)，那麼進入正題怎麼實現看下面我簡單的程式碼格式，注意註釋的地方和函式名類名都是與__all__內相關聯的

'''
文件快速生成註釋的方法介紹,首先我們要用到__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)
 

    當然還可以從其它檔案引用的方式匯入這裡用到python常用的匯入方式from從哪個目錄import匯入什麼檔案pythonzhushi
    help幫助方法就是幫我們檢視到此檔案中所包含的類，函式,的一個簡單幫助文件，類似於readme文件的一個說明。