Python笔记：第三部分 语句与语法 第十五章 文档资源

Python文档资源

形式	作用
# 注释	源文件文档
dir函数	以列表显示对象中可用的属性
文档字符串：__ doc __	附加在对象上的源文件文档
PyDoc：help函数	交互式命令行中的对象帮助
PyDoc：HTML报告	浏览器中的模块文档
Sphinx第三方工具	为大型项目提供更丰富的文档
标准手册集	官方的语言和库描述
网络资源	在线教程、示例
已出版的书籍	商业化加工后的参考文本

注释

• 文档字符串是较大型功能性文档的最优选择
• #注释则更适用于较小代码的文档，并最好被限制在脚本或函数一条一小组语句的范围内

dir函数

• 内置的dir函数是抓取对象内任何有属性的对象，包括导入的模块、内置类型和数据类型的名称

文档字符串：__ doc __

• 除了#注释以外，Python支持可自动附加在对象上的文档，从而可以在运行时查看
• 从语法上讲，这种注释被写成字符串，放在模块文件、函数以及类语句的顶部，位于任何可执行代码之前
• 文档协议的意义在于，当文件被导入后，继续让注释保存在__doc__属性中以供查阅。
• 为显示该模块以及对象关联的文档字符串，我们只需要导入该文件，直接打印其__doc__属性即可（即Python存储文档字符串中文本的地方）。

PyDoc：help函数

• help()函数用于查看函数或模块用途的详细说明。
• 当你调用help的时候，不一定要导入对应模块，但如果需要用help获取对应模块的文档信息，就需要导入模块。
• help()也可以像对内置模块一样，用在自己的模块上。

PyDoc：HTML报告

• 在WEB浏览器中更图形化的渲染并打开模块文档
• 打开方式：在cmd中输入:python -m pydoc -b