参考链接: Python help()
一 以注释方式为类添加帮助文档
我们知道,Python中可以使用help('模块名')或者help(类名)的形式来查看一个模块或者类的帮助文档,...我们也可以为自定义的类添加帮助文档,并用help进行查看.Python中用三对双引号可以进行多行注释,当我们把这种注释内容放到一个类或者函数定义的下面时,它会自动被当作该类或者函数的帮助文档.请看下面的类...add进行了注释,那么我们就可以通过下面的方式查看该模块和类的帮助. ...,导入doctest.testmod()会自动在终端测试我们所写的这些例子:
hyman@hyman-VirtualBox:~/projects/pythonTs$ python docts.py
hyman...
>>> mt.add(3,-2)
0 再运行就报错了(注意写运行示例时,>>>和python语句之间要有一个空格,否则会出现语法错误.)
hyman@hyman-VirtualBox