Python函数文档化字符串

开源WebGIS

Python函数文档化字符串

2016-09-14 作者: zhangxiang 浏览: 2230 次

摘要: 在Python中有一个奇妙的特性,文档字符串,又称为DocStrings。用它可以为我们的模块,类,函数添加说明性的文字,令其容易理解。更重要的是可以通过Python自带的标准方法将这些描述性文字信息输出。下面举例说明。 def printMax(x, y):...

在Python中有一个奇妙的特性,文档字符串,又称为DocStrings。用它可以为我们的模块,类,函数添加说明性的文字,令其容易理解。更重要的是可以通过Python自带的标准方法将这些描述性文字信息输出。下面举例说明。

def printMax(x, y):
    '''打印两个数中的最大值。    两个值必须是整数。'''
    x = int(x) # 如果可能,转换为整数
    y = int(y)

    if x > y:
        print(x, '最大')
    else:
        print(y, '最大')

printMax(3, 5)
print(printMax.__doc__)

输出:

5 最大
打印两个数中的最大值。    
两个值必须是整数。

函数的第一个逻辑行的字符串是那个函数的文档字符串。文档的以贯例是多行字符串,第一行以大写字母开头以句点(.)结束,第二行是空行,从第三行开始是详细描述。这是重要的函数写文档字符串要遵循的贯例。

关注“开源集思”公众号
获取免费资源

随机推荐


Copyright © from 2014. 开源地理空间基金会中文分会 吉ICP备05002032号

Powered by TorCMS

OSGeo 中国中心 邮件列表

问题讨论 : 要订阅或者退订列表,请点击 订阅

发言 : 请写信给: osgeo-china@lists.osgeo.org