Python中的Doc String 函数描述

将文档写在程序里，是LISP中的一个特色，Python也借鉴过。每个函数都是一个对象，每个函数对象都是有一个__doc__的属性，函数语句中，如果第一个表达式是一个string，这个函数的__doc__就是这个string，否则__doc__是None。

 
>>> def testfun():  
    """ 
this function do nothing , just demostrate the use of the doc string . 
"""  
    pass  
  
>>> testfun.__doc__  
'\nthis function do nothing , just demostrate the use of the doc string .\n'  
>>> #pass 语句是空语句，什么也不干，就像C语言中的{} ， 通过显示__doc__，我们可以查看一些内部函数的帮助信息   
>>> " ".join.__doc__  
'S.join(iterable) -> str\n\nReturn a string which is the concatenation of the strings in the\niterable.  The separator between elements is S.'  
>>>   

>>> def testfun():
	"""
this function do nothing , just demostrate the use of the doc string .
"""
	pass

>>> testfun.__doc__
'\nthis function do nothing , just demostrate the use of the doc string .\n'
>>> #pass 语句是空语句，什么也不干，就像C语言中的{} ， 通过显示__doc__，我们可以查看一些内部函数的帮助信息
>>> " ".join.__doc__
'S.join(iterable) -> str\n\nReturn a string which is the concatenation of the strings in the\niterable.  The separator between elements is S.'
>>> 

补充：Web开发 , Python ,

上一个：python多线程+队列下载资源
下一个：Python中的模块(module)和包(package)