對(duì)python的文件內(nèi)注釋 help注釋方法
目的:
在help(模塊名)時(shí),能夠看見(jiàn)文件里面的注釋。
首先,在文件的最開(kāi)頭,如果有個(gè)多行注釋(三引號(hào)),就會(huì)將注釋寫(xiě)入__DOC__變量,在help查看時(shí),可以看見(jiàn)這個(gè)變量。
如果還需要輸出函數(shù),則可以將函數(shù)放入__all__變量。
__all__ = ['search','fix','hello','parser']
all里面的元素是唯一的,所以,這里要避免函數(shù)重名。當(dāng)然,python對(duì)函數(shù)的重載也不是很提倡……
這樣在python命令行,可以看見(jiàn)注釋了。
比如一個(gè)程序是test02.py,先import它,再看
help(test02)
或者在程序中調(diào)用print(help(test02))
源代碼:
#test02.py """ author:Zhao Zhenyu this is an absolute test program. """ __all__ = ["function1", "function2"] def function1(): pass def function2(): """2nd """ pass
執(zhí)行情況:
>>> import test02 >>> help(test02) Help on module test02: NAME test02 DESCRIPTION author:Zhao Zhenyu this is an absolute test program. FUNCTIONS function1() function2() 2nd DATA __all__ = ['function1', 'function2'] FILE c:\users\lenovo\documents\python scripts\python_spider\csdn例子\test02.py >>>
以上這篇對(duì)python的文件內(nèi)注釋 help注釋方法就是小編分享給大家的全部?jī)?nèi)容了,希望能給大家一個(gè)參考,也希望大家多多支持腳本之家。
相關(guān)文章
pandas數(shù)據(jù)合并之pd.concat()用法詳解
本文主要介紹了pandas數(shù)據(jù)合并之pd.concat()用法詳解,文中通過(guò)示例代碼介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友們下面隨著小編來(lái)一起學(xué)習(xí)學(xué)習(xí)吧2022-06-06利用Python計(jì)算質(zhì)數(shù)與完全數(shù)的方法實(shí)例
這篇文章主要介紹了利用Python計(jì)算質(zhì)數(shù)與完全數(shù)的相關(guān)資料,文中通過(guò)示例代碼介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友們下面隨著小編來(lái)一起學(xué)習(xí)學(xué)習(xí)吧2021-03-03封裝Detours用于Python中x64函數(shù)hook詳解
Detours是微軟發(fā)布的一個(gè)API hook框架,同時(shí)支持x86和x64,看文檔說(shuō)也支持ARM和ARM64的Windows,這篇文章主要介紹了封裝Detours用于Python中x64函數(shù)hook,需要的朋友可以參考下2023-12-12Python時(shí)間序列數(shù)據(jù)的預(yù)處理方法總結(jié)
這篇文章主要介紹了Python時(shí)間序列數(shù)據(jù)的預(yù)處理方法總結(jié),時(shí)間序列數(shù)據(jù)隨處可見(jiàn),要進(jìn)行時(shí)間序列分析,我們必須先對(duì)數(shù)據(jù)進(jìn)行預(yù)處理。時(shí)間序列預(yù)處理技術(shù)對(duì)數(shù)據(jù)建模的準(zhǔn)確性有重大影響2022-07-07Python中的type與isinstance的區(qū)別詳解
本文主要介紹了Python中的type與isinstance的區(qū)別詳解,文中通過(guò)示例代碼介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友們下面隨著小編來(lái)一起學(xué)習(xí)學(xué)習(xí)吧2023-04-04python利用pytesseract 實(shí)現(xiàn)本地識(shí)別圖片文字
這篇文章主要介紹了python利用pytesseract 實(shí)現(xiàn)本地識(shí)別圖片文字,幫助大家更好的理解和使用python,感興趣的朋友可以了解下2020-12-12