说明文档:就是一行注释,在每次 定义一个函数后(def XXX(): 的下一行),开发的人写一段注释文字,告诉别人这个函数是干嘛用的。
案例:定义函数的说明文档
① 定义函数的说明文档
# 1、定义一个menu菜单函数 def menu(): pass # 2、定义通讯录增加操作方法 def add_student(): # 说明文档:就是一行注释,定义一个函数后(def XXX(): 的下一行) """ 函数的说明文档:add_student方法不需要传递任何参数,其功能就是实现对通讯录的增加操作 """ pass # 3、定义通讯录删除操作方法 def del_student(): pass # 4、定义通讯录修改操作方法 def modify_student(): pass # 5、定义通讯录查询操作方法 def find_student(): pass
② 调用函数的说明文档
help(函数名称)
案例:调用add_student()方法
help(add_student)