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 的好坏。

进一步阅读

国际娱乐平台时时彩 内蒙古时时彩投注技巧 时时彩定位胆计划软件手机版 时时彩输光30万 时时彩源码搭建教程
江西时时彩还有在卖吗 学软件开发多少钱 时时彩杀号定胆软件 神算时时彩3期必中版 诺亚方舟分级基金软件
重庆时时彩高手计划群 灵气重庆时时彩辅助 时时彩助手 重庆时时彩vv 怎么开一个时时彩网站
时时彩qq群发工具 江西时时彩组三技巧 梦彩时时彩软件重庆 彩票大赢家过滤软件 时时彩更新走势图
江西十一选五遗漏数据 北京快乐八玩法 斗地主棋牌 辽宁快乐12开奖走势 天津11选5遗漏导航
江苏快3开奖查询计划■江苏快3投注技巧去哪查计划■江苏快3快彩乐 快中彩中6个多少钱 斗地主赢话费 威博 20选5开奖结果查询
贵州快三全部走势图 新疆时时彩开奖号码走势图 香港开奖结果2018 香港六合彩开奖结果表 内蒙古11选5遗漏
北京赛车pk拾走势 德州扑克大小顺序 北京赛车pk10贴吧 天津十一选五开将 金博880特码报