59、Python 文档指南：从基础到实践

Python 文档指南：从基础到实践

1. 查看类型属性

在 Python 中，我们可以通过 dir 函数查看类型的内置属性。既可以将类型的名称传递给 dir 函数，也可以传递该类型的字面量，二者结果相同。示例如下：

>>> dir(str) == dir('')
True
>>> dir(list) == dir([])
True

这是因为像 str 和 list 这样的名称，在 Python 中现在是类型名称，调用它们会触发构造函数，生成该类型的实例。不过， dir 函数返回的属性名称列表缺乏对这些名称含义的额外说明，我们需要从其他文档来源获取这些信息。

一些 Python 的集成开发环境（IDE），如 IDLE，有内置机制可自动在窗口中显示对象的属性列表，可作为 dir 命令的替代。例如，在 IDLE 中，在对象名称后输入点号，稍作等待或按下 Tab 键，会显示对象属性的下拉列表，但这主要是自动补全机制，并非信息来源。

2. 文档字符串（Docstrings）

Python 除了支持用 # 注释外，还支持自动将文档附加到对象，并在程序运行时供用户查看。从语法上看，这些注释是作为字符串放置在模块文件、函数或类定义的开头，在可执行代码之前。Python 会自动将这些字符串内容（即文档字符串）插入