2.3. 文档化函数

可以通过给出一个 doc string (文档字符串) 来文档化一个 Python 函数。

例 2.2. 定义 buildConnectionString 函数的 doc string


def buildConnectionString(params):
    """Build a connection string from a dictionary of parameters.

    Returns string."""

三重引号表示一个多行字符串。在开始与结束引号间的所有东西都被视为单个字符串的一部分,包括硬回车和其它的引号字符。您可以在任何地方使用它们,但是您可能会发现,它们经常被用于定义 doc string

三重引号也是一种定义既包含单引号又包含双引号的字符串的简单方法,就像 Perl 中的 qq/.../

在三重引号中的任何东西都是这个函数的 doc string,它们用来说明函数可以做什么。如果存在 doc string,它必须是一个函数要定义的第一个内容 (也就是说,在冒号后面的第一个内容)。在技术上不要求给出函数的 doc string,但是您应该这样做。我相信在您上过的每一种编程课上都听到过这一点,但是 Python 带给您一些额外的动机:doc string 在运行时可作为函数的属性。

许多 Python IDE 使用 doc string 来提供上下文敏感的文档信息,所以当键入一个函数名时,它的 doc string 显示为一个工具提示。这一点可以说非常有用,但是它的好坏取决于您书写的 doc string 的好坏。

进一步阅读

重庆时时彩前三和值 重庆时时彩破解软件3.0 江西时时彩皇恩娱乐 重庆时时彩软件杀号 内蒙古时时彩赚钱吗
时时彩软件破解版论坛 玩时时彩被骗了怎么办 时时彩助赢软件下载 江西时时彩前三走势 内蒙时时彩11选5走势图
cnc娱乐 新时时彩单双追号 凤凰时时彩平台黑钱 免费的挂机时时彩软件 时时彩平台手机客户端
福少时时彩软件怎么用 网上玩时时彩犯法吗 最准的时时彩软件 3m互助平台最新消息 万豪会时时彩平台账号注册