本篇文章给大家分享的是有关python docstring是什么意思,小编觉得挺实用的,因此分享给大家学习,希望大家阅读完这篇文章后可以有所收获,话不多说,跟着小编一起来看看吧。
Docstring是一种文档字符串,用于解释构造的作用。我们在函数、类或方法中将它放在首位来描述其作用。我们用三个单引号或双引号来声明docstring。
>>> def sayhi():
"""
用该函数打印Hi
"""
print("Hi")
>>> sayhi()
Hi
要想获取一个函数的docstring,我们使用它的_doc_属性
>>> sayhi.__doc__
‘
This function prints Hi
’
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 docstring是什么意思,小编相信有部分知识点可能是我们日常工作会见到或用到的。希望你能通过这篇文章学到更多知识。更多详情敬请关注亿速云行业资讯频道。
亿速云「云服务器」,即开即用、新一代英特尔至强铂金CPU、三副本存储NVMe SSD云盘,价格低至29元/月。点击查看>>
免责声明:本站发布的内容(图片、视频和文字)以原创、转载和分享为主,文章观点不代表本网站立场,如果涉及侵权请联系站长邮箱:is@yisu.com进行举报,并提供相关证据,一经查实,将立刻删除涉嫌侵权内容。