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

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

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

#!/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測試

固然我這裏仍是用圖片來展現如下:spa

是否是一目瞭然,這樣也能夠導入咱們須要作的註釋文檔,help幫助方法就是幫咱們查看到此文件中所包含的類,函數,的一個簡單幫助文檔,相似於readme文檔的一個說明。最後來看看掩飾效果吧:code

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

相關文章
相關標籤/搜索