导语:
本文主要介绍了关于python docstring是什么的相关知识,包括python语言,以及python中!=是什么这些编程知识,希望对大家有参考作用。
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
本文为原创文章,版权归知行编程网所有,欢迎分享本文,转载请保留出处!
你可能也喜欢
- ♥ 如何使用python3输出csv文件?10/06
- ♥ 如何在python中的块中运行10/26
- ♥ 如何在 python 中安装 talib11/23
- ♥ python程序的执行原理09/01
- ♥ 如何在python中以毫秒为单位获取系统时间10/08
- ♥ python中argparse库是什么09/29
内容反馈