当前位置:首页>python>小白学python第46天之函数中的说明文档

小白学python第46天之函数中的说明文档

  • 2026-08-27 14:05:21
小白学python第46天之函数中的说明文档

1.22

函数中的说明文档

?

学前疑问

前两天,我们已经学习了python函数,也知道函数代码可以被重复使用,那如果别人想调用我们定义函数,他如何清楚这个函数具体作用呢?

1

函数中的说明文档

(1)什么是说明文档

思考:定义一个函数后,程序员如何书写程序能够快速提示这个函数的作用?

答:注释

思考:如果代码多,我们是不是需要在很多代码中找到这个函数定义的位置才能看到注释?如果想更方便的查看函数的作用怎么办?

答:函数的说明文档(函数的说明文档也叫函数的文档说明)

(2)定义函数的说明文档

a、定义函数的说明文档

# 1、定义一个menu菜单函数def menu():    pass# 2、定义通讯录增加操作方法def add_student():    """ 函数说明文档:add_student方法不需要传递任何参数,其功能就是实现对通讯录的增加操作 """    pass# 3、定义通讯录删除操作方法def del_student():    pass# 4、定义通讯录修改操作方法def modify_student():    pass# 5、定义通讯录查询操作方法def find_student():    pass

b、调用函数的说明文档

help(函数名称)

c、调用add_student()方法

help(add_student)

(3)封装一个函数,用于生成指定长度的验证码

# 定义一个generate_code()函数def generate_code(num):    """ generate_code方法主要用于生成指定长度的验证码,有一个num参数,需要传递一个int类型的数值,其return返回结果为num"""    import random    # 第一步:定义一个字符串    str1 = "0123456789abcdefghijklmnopqrstuvwxyABCDEFGHIJKLMNOPQRSTUVWXYZ"    # 第二步:循环num次,代表生成num长度的字符串    code = ''    for i in range(num):        # 第三步:从字符串中随机抽取num个字符        index = random.randint(0, len(str1) -1)        code += str1[index]    # 第四步:使用return返回验证码    return code# 求帮助(查看generate_code函数的作用以及需要传递的参数)# help(generate_code)# 调用函数print(generate_code(4))

今日学习完毕,课后作业:

写一个随机生成6位数字密码的函数。

最新文章

随机文章