Python----函数中的说明文档

说明文档:就是一行注释,在每次 定义一个函数后(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)

相关推荐
小杨40417 分钟前
python入门系列十四(多进程)
人工智能·python·pycharm
用户277844910499315 小时前
借助DeepSeek智能生成测试用例:从提示词到Excel表格的全流程实践
人工智能·python
JavaEdge在掘金17 小时前
ssl.SSLCertVerificationError报错解决方案
python
我不会编程55518 小时前
Python Cookbook-5.1 对字典排序
开发语言·数据结构·python
李少兄18 小时前
Unirest:优雅的Java HTTP客户端库
java·开发语言·http
老歌老听老掉牙18 小时前
平面旋转与交线投影夹角计算
python·线性代数·平面·sympy
满怀101518 小时前
Python入门(7):模块
python
无名之逆18 小时前
Rust 开发提效神器:lombok-macros 宏库
服务器·开发语言·前端·数据库·后端·python·rust
你觉得20518 小时前
哈尔滨工业大学DeepSeek公开课:探索大模型原理、技术与应用从GPT到DeepSeek|附视频与讲义下载方法
大数据·人工智能·python·gpt·学习·机器学习·aigc
似水এ᭄往昔18 小时前
【C语言】文件操作
c语言·开发语言