帮助手册
回忆上次内容
- 上次了解了注释
- 注释分为两种
- 多行注释还有什么特殊功能么?🤔
增加描述说明
#!/usr/bin/python3
'''
关于当前模块的说明
'''
- 完整的main.py如下所示
- :r !whoami
- :r !date
- :w
刷新帮助手册
- 这很眼熟啊
- 可以到游乐场里面
- 首先 import main
- 然后 help(main)
生成帮助手册
- 在当前路径,进入游乐场之后
- 可以生成帮助网页吗?
- 官方的帮助什么样子?
python3 在线
生成网页
python3 -m pydoc -w main
- 对于 main.py 生成帮助网页
- 帮助文件叫做 main.html
打开帮助网页
- 右上角是两个链接
- 下面是 main 里面的内容
- 再下面是三个链接
- 是 main.py 引入的三个 module
- 目前这三个模块的链接都无法打开
- 因为没有生成
更新其他模块帮助文件
- 修改三个 py 文件的内容
- 其中 get_fruits 本来就有三引号注释
python3 -m pydoc -w get_fruits
- 只有顶端的三引号注释才被写入模块帮助
- 下面的三引号注释被忽略
修改模块注释
- 修改 get_fruits.py
- 保存并写帮助网页
python3 -m pydoc -w get_fruits
代码即文档
- 让源代码更容易阅读和理解
- 尽量减少维护或扩展遗留系统所需的工作量
- 减少系统的用户和开发人员查阅二级文档来源的需要
- 通过自成一体的知识表征促进自动化
这很敏捷
总结
- 这次了解了 帮助文档的 生成
- 开头的三引号注释 可以生成 帮助文档
- 文档 可以写成网页
- python3 本身
- 目前的程序
- 有
什么
方法
- 下次再说!👋
- 蓝桥->https://www.lanqiao.cn/courses/3584
- github->https://github.com/overmind1980/oeasy-python-tutorial
- gitee->https://gitee.com/overmind1980/oeasypython