你可以通过为 Python 函数提供 文档字符串 来为其编写文档。
示例 2.2. 定义 buildConnectionString 函数的 文档字符串
def buildConnectionString(params): """Build a connection string from a dictionary of parameters. Returns string."""
三个引号表示多行字符串。开始和结束引号之间的所有内容都是单个字符串的一部分，包括回车符和其他引号字符。你可以在任何地方使用它们，但你会发现它们最常用于定义 文档字符串。
 |
|
| 三个引号也是定义同时包含单引号和双引号的字符串的简单方法，就像 Perl 中的 qq/.../。 | |
三个引号之间的所有内容都是函数的 文档字符串，它记录了函数的功能。如果存在 文档字符串，则它必须是函数中定义的第一件事（即冒号后的第一件事）。从技术上讲，你不需要为函数提供 文档字符串，但你应该始终这样做。我知道你在你上过的每一节编程课上都听过这句话，但 Python 为你提供了一个额外的激励：文档字符串 在运行时可用作函数的属性。
|
|
| 许多 Python IDE 使用 文档字符串 提供上下文相关文档，因此当你键入函数名称时，其 文档字符串 会显示为工具提示。这可能非常有帮助，但这取决于你编写的 文档字符串 的质量。 | |
函数文档的进一步阅读
- PEP 257 定义了 文档字符串 约定。
- Python 教程 讨论了文档字符串 中的间距约定。