目的：

在help(模塊名)時(shí)，能夠看見文件里面的注釋。

首先，在文件的最開頭，如果有個(gè)多行注釋（三引號(hào)），就會(huì)將注釋寫入__DOC__變量，在help查看時(shí)，可以看見這個(gè)變量。

如果還需要輸出函數(shù)，則可以將函數(shù)放入__all__變量。

__all__ = ['search','fix','hello','parser']

all里面的元素是唯一的，所以，這里要避免函數(shù)重名。當(dāng)然，python對(duì)函數(shù)的重載也不是很提倡……

這樣在python命令行，可以看見注釋了。

比如一個(gè)程序是test02.py，先import它，再看

help(test02)

或者在程序中調(diào)用print(help(test02))

源代碼：

#test02.py"""author:Zhao Zhenyuthis is an absolute test program."""__all__ = ["function1", "function2"]def function1():passdef function2():"""2nd"""pass

執(zhí)行情況：

>>> 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>>>

以上這篇對(duì)python的文件內(nèi)注釋 help注釋方法就是小編分享給大家的全部內(nèi)容了，希望能給大家一個(gè)參考，也希望大家多多支持武林站長站。