参考链接: Python help()
一 以注释方式为类添加帮助文档
我们知道,Python中可以使用help('模块名')或者help(类名)的形式来查看一个模块或者类的帮助文档,...我们也可以为自定义的类添加帮助文档,并用help进行查看.Python中用三对双引号可以进行多行注释,当我们把这种注释内容放到一个类或者函数定义的下面时,它会自动被当作该类或者函数的帮助文档.请看下面的类... 我们在上面的模块中加入下面这段代码:
if __name__=='__main__':
import doctest
doctest.testmod() 请注意我们写的注释中的下面这段内容...mt=MyMath()
>>> mt.add(1,2)
3
>>> mt.add(2.4,1.5)
3.9 当我们在终端中运行该模块时...
>>> mt.add(3,-2)
0 再运行就报错了(注意写运行示例时,>>>和python语句之间要有一个空格,否则会出现语法错误.)
hyman@hyman-VirtualBox