python快速產生註解文檔的方法

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外面,這樣也是沒顯示效果的。大家趕緊去試試吧。感謝觀看。 。