Python快速從注釋生成文檔的方法
作為一個(gè)標(biāo)準(zhǔn)的程序猿，為程序編寫說明文檔是一步必不可少的工作，如何才能寫的又好又快呢，下面我們就來詳細(xì)探討下吧。
今天將告訴大家一個(gè)簡單平時(shí)只要注意的小細(xì)節(jié)，就可以輕松生成注釋文檔，也可以檢查我們寫的類方法引用名稱是否重復(fù)有問題等。
一看別人專業(yè)的大牛們寫的文檔多牛多羨慕，不用擔(dān)心我們可以讓python為我們生成基本滿足的說明文檔，一來可以提高代碼整體閱讀性，二來可以將代碼的整體結(jié)構(gòu)看著也更清晰，這樣在交接的時(shí)候可以省很多麻煩，其它同事在接手你工作的時(shí)候也不會一行行去問你這是什么那是什么的，因?yàn)樽⑨屢呀?jīng)很直觀的表述了，在整合的時(shí)候可當(dāng)說明文檔給客戶簡單說明(主要是給你BOSS看的).
那么進(jìn)入正題怎么實(shí)現(xiàn)看下面我簡單的代碼格式，注意注釋的地方和函數(shù)名類名都是與__all__內(nèi)相關(guān)聯(lián)的
#!/usr/bin/env python # -*-coding:utf-8 -*- ''' 文檔快速生成注釋的方法介紹,首先我們要用到__all__屬性 在Py中使用為導(dǎo)出__all__中的所有類、函數(shù)、變量成員等 在模塊使用__all__屬性可避免相互引用時(shí)命名沖突 ''' __all__ = ['Login', 'check', 'Shop', 'upDateIt', 'findIt', 'deleteIt', 'createIt'] class Login: ''' 測試注釋一可以寫上此類的作用說明等 例如此方法用來寫登錄 ''' def __init__(self): ''' 初始化你要的參數(shù)說明 那么登錄可能要用到 用戶名username 密碼password ''' pass def check(self): ''' 協(xié)商你要實(shí)現(xiàn)的功能說明 功能也有很多例如驗(yàn)證 判斷語句，驗(yàn)證碼之類的 ''' pass class Shop: ''' 商品類所包含的屬性及方法 update改/更新 find查找 delete刪除 create添加 ''' def __init__(self): ''' 初始化商品的價(jià)格、日期、分類等 ''' pass def upDateIt(self): ''' 用來更新商品信息 ''' pass def findIt(self): ''' 查找商品信息 ''' pass def deleteIt(self): ''' 刪除過期下架商品信息 ''' pass def createIt(self): ''' 創(chuàng)建新商品及上架信息 ''' pass if __name__=="__main__": import pythonzhushi print help(pythonzhushi)
這里要強(qiáng)調(diào)說明下py的名字要和你當(dāng)前工作的py名字一樣(我這里創(chuàng)建的py名字就是pythonzhushi,最后導(dǎo)入也是這名字)，因?yàn)橄旅娴臏y試中import的導(dǎo)入的是自身所以,im port 名稱 和Help(名稱)以及你的文件名稱要一致才可以。為了更加直觀請看下面這圖：
當(dāng)然還可以從其它文件引用的方式導(dǎo)入這里用到python常用的導(dǎo)入方式from從哪個(gè)目錄import導(dǎo)入什么文件pythonzhushi
當(dāng)然我這里還是用圖片來展示以下：
是不是一目了然，這樣也可以導(dǎo)入我們需要做的注釋文檔，help幫助方法就是幫我們查看到此文件中所包含的類，函數(shù),的一個(gè)簡單幫助文檔，類似于readme文檔的一個(gè)說明。最后來看看掩飾效果吧：
是不是簡單的打印出我們程序的說明文檔，后面步驟直接可以建一個(gè)文本把這個(gè)粘貼過去，就完成一個(gè)readme的文檔說明，經(jīng)過測試有幾點(diǎn)注意是，想要寫#這種注釋不要寫到def放發(fā)內(nèi)要寫到它的上面位置和裝飾器類似，相反三引號'''不要寫到def外面,這樣也是沒顯示效果的。大家趕緊去試試吧。感謝觀看。。
- Python實(shí)現(xiàn)多行注釋的另類方法
- Python中的多行注釋文檔編寫風(fēng)格匯總
- Python注釋詳解
- python訪問類中docstring注釋的實(shí)現(xiàn)方法
- Python中的單行、多行、中文注釋方法
- 學(xué)習(xí)python分支結(jié)構(gòu)
- Python分支結(jié)構(gòu)（switch）操作簡介
- Python循環(huán)結(jié)構(gòu)的應(yīng)用場景詳解
- 詳解Python的循環(huán)結(jié)構(gòu)知識點(diǎn)
- Python之循環(huán)結(jié)構(gòu)
- Python的for和break循環(huán)結(jié)構(gòu)中使用else語句的技巧
- Python注釋、分支結(jié)構(gòu)、循環(huán)結(jié)構(gòu)、偽“選擇結(jié)構(gòu)”用法實(shí)例分析
相關(guān)文章
Python中有三種內(nèi)建的數(shù)據(jù)結(jié)構(gòu)：列表、元祖和字典，這篇文章對這三種數(shù)據(jù)結(jié)構(gòu)進(jìn)行了分別的介紹與實(shí)例演示，讓大家更簡潔明了的了解這三個(gè)之間的區(qū)別，下面一起來看看。2016-08-08
Python實(shí)現(xiàn)基本數(shù)據(jù)結(jié)構(gòu)中隊(duì)列的操作方法示例
這篇文章主要介紹了Python實(shí)現(xiàn)基本數(shù)據(jù)結(jié)構(gòu)中隊(duì)列的操作方法,結(jié)合實(shí)例形式演示了Python針對數(shù)據(jù)結(jié)構(gòu)中隊(duì)列的初始化、插入、刪除、判斷隊(duì)列滿及隊(duì)列空等相關(guān)操作技巧,需要的朋友可以參考下2017-12-12
本文會介紹如何將語句組織成函數(shù)，還會詳細(xì)介紹參數(shù)和作用域的概念，以及遞歸的概念及其在程序中的用途。2013-11-11
如何對csv文件數(shù)據(jù)分組,并用pyecharts展示
這篇文章主要介紹了如何對csv文件數(shù)據(jù)分組,并用pyecharts展示，具有很好的參考價(jià)值，希望對大家有所幫助。如有錯(cuò)誤或未考慮完全的地方，望不吝賜教2022-11-11
這篇文章主要介紹了WxPython中控件隱藏與顯示的小技巧，具有很好的參考價(jià)值，希望對大家有所幫助。如有錯(cuò)誤或未考慮完全的地方，望不吝賜教2022-11-11
Python作為一種強(qiáng)大的編程語言,廣泛應(yīng)用于數(shù)據(jù)科學(xué)、機(jī)器學(xué)習(xí)、Web開發(fā)以及圖形化編程等領(lǐng)域,在圖形化編程方面,Python提供了多種庫和工具,幫助開發(fā)者快速構(gòu)建用戶界面和圖形應(yīng)用,本文將介紹幾種流行的Python圖形化工具,需要的朋友可以參考下2024-12-12
下面小編就為大家分享一篇python 顯示數(shù)組全部元素的方法，具有很好的參考價(jià)值，希望對大家有所幫助。一起跟隨小編過來看看吧2018-04-04
親手教你實(shí)現(xiàn)pynq-z2條形碼識別功能
這篇文章主要介紹了pynq-z2條形碼識別功能,本文給大家介紹的非常詳細(xì)，對大家的學(xué)習(xí)或工作具有一定的參考借鑒價(jià)值，需要的朋友可以參考下2022-07-07
這篇文章主要介紹了Python線程之定位與銷毀的實(shí)現(xiàn),小編覺得挺不錯(cuò)的，現(xiàn)在分享給大家，也給大家做個(gè)參考。一起跟隨小編過來看看吧2019-02-02
使用Python OpenCV為CNN增加圖像樣本的實(shí)現(xiàn)
這篇文章主要介紹了使用Python OpenCV為CNN增加圖像樣本的實(shí)現(xiàn)，小編覺得挺不錯(cuò)的，現(xiàn)在分享給大家，也給大家做個(gè)參考。一起跟隨小編過來看看吧2019-06-06