当前位置: 首页 > Python编程 > Python编程实战技能 > Python编程基础入门 > python docstring是什么

python docstring是什么

发布时间:2020年09月27日 08:29:14 来源: 点击量:744

【摘要】Docstring是一种文档字符串,用于解释构造的作用。我们在函数、类或方法中将它放在首位来描述其作用。我们用三个单引号或双引号来声明docst

Docstring是一种文档字符串,用于解释构造的作用。我们在函数、类或方法中将它放在首位来描述其作用。我们用三个单引号或双引号来声明docstring。

>>> def sayhi():
 """
用该函数打印Hi
"""
 print("Hi") 
>>> sayhi()
Hi

要想获取一个函数的docstring,我们使用它的_doc_属性

>>> sayhi.__doc__
‘
  This function prints Hi
’

相关推荐:《Python基础教程》

docstring,不仅可以编写代码,同时也能写出文档,保持代码和文档的一致。

docstring说白了就是一堆代码中的注释。

Python的docstring可以通过help函数直接输出一份有格式的文档。

编写test.py

def printMax(x, y):
    '''Prints the maximum of two numbers.
    The two values must be integers.'''
    x = int(x) # convert to integers, if possible
    y = int(y)
    if x > y:
         print (x, 'is maximum')
    else:
         print (y, 'is maximum')
printMax(3, 5)
print (printMax.__doc__)

命令行输入 help(test)

import test
5 is maximum
Prints the maximum of two numbers.
    The two values must be integers.
help(test)
Help on module test:
NAME
    test - Created on Sat Jun  2 19:05:08 2018
DESCRIPTION
    @author: linzhiwei02
FUNCTIONS
    printMax(x, y)
        Prints the maximum of two numbers.
        The two values must be integers.
FILE
    /Users/linzhiwei02/Desktop/test.py

分享到: 编辑:wangmin

就业培训申请领取
您的姓名
您的电话
意向课程
点击领取

环球青藤

官方QQ

扫描上方二维码或点击一键加群,免费领取大礼包,加群暗号:青藤。 一键加群

绑定手机号

应《中华人民共和国网络安全法》加强实名认证机制要求,同时为更加全面的体验产品服务,烦请您绑定手机号.

预约成功

本直播为付费学员的直播课节

请您购买课程后再预约

环球青藤移动课堂APP 直播、听课。职达未来!

安卓版

下载

iPhone版

下载
环球青藤官方微信服务平台

刷题看课 APP下载

免费直播 一键购课

代报名等人工服务

课程咨询 学员服务 公众号

扫描关注微信公众号

APP

扫描下载APP

返回顶部