知行编程网知行编程网  2022-09-15 19:30 知行编程网 隐藏边栏  2 
文章评分 0 次,平均分 0.0
导语: 本文主要介绍了关于python docstring是什么的相关知识,包括python语言,以及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

本文为原创文章,版权归所有,欢迎分享本文,转载请保留出处!

知行编程网
知行编程网 关注:1    粉丝:1
这个人很懒,什么都没写
扫一扫二维码分享