玩蛇网提供最新Python编程技术信息以及Python资源下载!
您现在的位置: 玩蛇网首页 > Python进阶教程 > 正文内容

Python基础入门必备

Python 函数文档字符串 说明docstring

Python基础教程(第2版 修订版)
玩蛇网推荐图文教程: python黑客多线程扫描器

Python的函数文档字符串是在函数开头,用来解释其接口的字符串
举例说明:

#-*- coding: utf-8 -*-
#测试代码,没有实际用途

def fun_doc(t, n ,length, angle):
    """
    绘制n个线段,给定长度和角度,单位是:度。
    """
    for i in range(n):
        fd(t, length)
        lt(t, angle)

这里的文档字符串是一个使用三引号括起来的字符串,三引号字符串又称为多行字符串,因为三个引号允许Python的字符串可以多行的展示。

虽然有时函数的文档字符串文字很少,但是已经包含了其他人需要知道的关于函数的基础信息和功能简介,文档与我们之前讲的单行注释概念不太一样。它精确的解释了这个函数提供了什么功能(玩蛇网提示:至于如何实现这个函数的等信息,不要写在这里面。)它解释了每个形参对函数行为的影响效果以及每个形参应有的类型

编写这类函数文档是接口设计的重要部分,一个设计良好的接口,也应当很简单就能解释清楚;如果你发现解释一个函数真的不太容易的话,很可能表示它的接口设计有改进的空间。

玩蛇网文章,转载请注明出处和来源网址:http://www.iplaypython.com/jinjie/jj156.html



微信公众号搜索"玩蛇网Python之家"加关注,每日最新的Python资讯、图文视频教程可以让你一手全掌握。强烈推荐关注!

微信扫描下图可直接关注

玩蛇网PythonQQ群,欢迎加入: ① 240764603 玩蛇网Python新手群
修订日期:2015-12-15 11:34 玩蛇网 www.iplaypython.com

我要分享到:    
评论列表(网友评论仅供网友表达个人看法,并不表明本站同意其观点或证实其描述)

必知PYTHON模块 Must Know PYTHON Modules