3100-188787-000310 帮助手册.sy.md

show	version	enable_checker
step	1.0	true

帮助手册

回忆上次内容

• 上次了解了注释
  • 注释是为了让程序更可读
  • 注释不会影响程序运行速度
• 注释分为两种
  • 单行的 - #
  • 多行的 - 三个"或'
• 多行注释还有什么特殊作用么？🤔

生成帮助手册

ls
python3 -m pydoc  main 

• 可以在命令行中查看到main.py的帮助手册

增加描述说明

#!/usr/bin/python3
#vim: set fileencoding=utf-8
'''
关于当前模块的说明
'''

• 写完之后保存
• 注意已经设置了编码格式
• 然后重新生成main.html
  • python3 -m pydoc main

刷新帮助手册

• python3 -m pydoc main

生成网页

• python3 -m pydoc -w main
  • 对于 main.py 生成帮助网页
  • 帮助文件叫做 main.html
  • 帮助文件 就生成在当前的apple文件夹

打开帮助网页

• 然后用火狐打开这个网页文件

• 左上角是两个链接
  • 当前文件夹索引
  • 当前html对应的py文件
• 下面是main里面的内容
  • 相关的三引号描述
• 再下面是三个链接
  • 是main.py引入的三个module
  • 目前这三个模块的链接都无法打开
  • 因为没有生成

更新其他模块帮助文件

• 修改三个py文件的内容
• 其中input本来就有三引号注释
  • python3 -m pydoc input

• 只有顶端的三引号注释才被写入模块帮助
• 下面的三引号注释被忽略

修改模块注释

• 修改input.py
• 保存并写帮助网页

• 任务完成
• 但并没有特别提高可读性

python3 在线

• python3 本身有在线的文档
• 在http://docs.python.org

总结

• 这次了解了帮助手册的生成
  • 在开头的三引号注释可以帮助生成文档
  • 文档可以写成网页
• python3本身也有在线的帮助手册
• 但目前的网页并没有解决程序可读性的问题
• 有什么方法让程序更可读么？🤔
• 下次再说！👋