当前位置: > python教程 > python基础教程 >

python中的文档字符串
栏目分类:python基础教程   发布日期:2019年07月09日 14:54:22   浏览次数:

文档字符串是用于说明的性质,当我们在看别人编写代码的时候,代码没有进于说明,那别人也不知道这段代码是干什么的,需要研究。所以,在定义函数时,可以在函数内部编写文档字符串,文档字符串就是函数的说明,当我们编写了文档字符串时,就可以通过help()函数来查看函数的说明

python中的文档字符串

1、用法: 文档字符串非常简单,其实直接在函数的第一行写一个字符串就是文档字符串

案例1:自己编写一个文档字符串,在函数内用三个单引号或三个爽引号

>>> #定义一个求和的函数

>>> def sum(a,b):

'''
这是一个文档字符串的说明:

函数的作用:求二个数的和

参数:a,b的类型是整形
......
......
......

'''

print(a+b)


2、通过help查看刚才定义的sum求和函数

>>> help(sum) 

Help on function sum in module __main__:
 

sum(a, b)

    函数的作用:求二个数的和

    参数:a,b的类型是整形


3、通过help查看python中的内置函数

>>> help(print)

Help on built-in function print in module builtins:

 

print(...)

    print(value, ..., sep=' ', end='\n', file=sys.stdout, flush=False)

    

    Prints the values to a stream, or to sys.stdout by default.

    Optional keyword arguments:

    file:  a file-like object (stream); defaults to the current sys.stdout.

    sep:   string inserted between values, default a space.

    end:   string appended after the last value, default a newline.

    flush: whether to forcibly flush the stream.

文档字符串一般来说,都是英文编写的,但是也没有这么多讲究,不用中文也没事,如果你的代码是给国内人看的,那就用中问,如果是对外的,那就用英文


 

相关热词:

下一篇:没有了
热门关键词
python字符串
     
python教程 python爬虫 python人工智能 Python+大数据 python问答