目的:
在help(模塊名)時,能夠看見文件里面的注釋。
首先,在文件的最開頭,如果有個多行注釋(三引號),就會將注釋寫入__DOC__變量,在help查看時,可以看見這個變量。
如果還需要輸出函數,則可以將函數放入__all__變量。
__all__ = ['search','fix','hello','parser']
all里面的元素是唯一的,所以,這里要避免函數重名。當然,python對函數的重載也不是很提倡……
這樣在python命令行,可以看見注釋了。
比如一個程序是test02.py,先import它,再看
help(test02)
或者在程序中調用print(help(test02))
源代碼:
#test02.py"""author:Zhao Zhenyuthis is an absolute test program."""__all__ = ["function1", "function2"]def function1():passdef function2():"""2nd"""pass
執行情況:
>>> import test02>>> help(test02)Help on module test02:NAMEtest02DESCRIPTIONauthor:Zhao Zhenyuthis is an absolute test program.FUNCTIONSfunction1()function2()2ndDATA__all__ = ['function1', 'function2']FILEc:/users/lenovo/documents/python scripts/python_spider/csdn例子/test02.py>>>
以上這篇對python的文件內注釋 help注釋方法就是小編分享給大家的全部內容了,希望能給大家一個參考,也希望大家多多支持VEVB武林網。
新聞熱點
疑難解答