模块帮助文档
1. 模块帮助文档
我们知道,在定义函数或者类时,可以为其添加说明文档,以方便用户清楚的知道该函数或者类的功能。自定义模块也不例外,也可以添加说明文档,与函数或类的添加方法相同,即只需在模块开头的位置定义一个字符串即可。
-
示例
# vi mymodule.py """ count()函数用于计算两个数值乘积 """ def count(a, b): result = a * b return f"{a}与{b}的乘积是: {result}" 查看模块帮助文档: 方式1: print(mymodule.__doc__) 方式2: help(mymodule)