python docstring是什么

您所在的位置:网站首页 inferred是什么意思 python docstring是什么

python docstring是什么

2023-05-23 09:55| 来源: 网络整理| 查看: 265

python docstring是什么

头像

爱喝马黛茶的安东尼

2019-10-09 10:36:226961浏览 · 0收藏 · 0评论

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 关注

关注公众号,随时随地在线学习

本教程部分素材来源于网络,版权问题联系站长!

分享

分享到微博

微信扫一扫

下一篇: python graph什么意思>



【本文地址】


今日新闻


推荐新闻


CopyRight 2018-2019 办公设备维修网 版权所有 豫ICP备15022753号-3