前面章节不止一次讲到,Python 支持给函数、类以及类方法添加说明性文档,并提供 help() 函数和 __doc__ 属性获取指定成员的说明文档。例如:
def display(add): ''' 这是一个函数 ''' print(add) class my_cla: ''' 这是一个类 ''' def say(self,add): ''' 这是一个类实例方法 ''' print(add) help(display)
程序输出结果为:
Help on function display in module __main__:
display(add)
这是一个函数
但是,说明性文档的功能还远不止此,它还可以用来包含一些测试代码,以测试该成员(函数、类、类方法)的功能是否正确。值得一提的是,说明性文档中测试该成员的代码和实际调用该成员时使用的代码是一样的,只不过作为测试代码,它有特定的编写格式。
在函数、类或类方法的说明性文档中,以>>>作为开始的内容就表示一行测试代码,并且接下来的一行则明确该测试代码的输出结果,以上面程序为例,为 display() 函数添加测试代码如下:
'''
这是一个函数
>>> display("http://c.biancheng.net/python/")
http://c.biancheng.net/python/
>>> display("http://c.biancheng.net/java/"