文档字符串 | Python从入门到精通:高阶篇之八

简介: 本节重点介绍了文档字符串的编写要求以及优势。更好地了解函数。

介绍返回值 | Python从入门到精通:高阶篇之七

文档字符串

在了解文档字符串之前,我们需要先去知道help()。
help()是Python中的内置函数,通过help()函数可以查询python中的函数的用法。

语法:help(函数对象)

现在来获取print()函数的使用说明。

help(print)

执行结果:

image.png

我们可以得到print()函数的具体使用说明。包括打印结果还有一些文件说明等。

接下来我们自定义一个函数。

def fn(a,b,c):
     return 10

help(fn)

执行结果:

image.png

此时可以发现,显示出来的信息不是很完全,是因为我们没有给函数去说明,所以没有信息输出,但是我们在开发过程中,有解释意义显然是更好一点。此时就需要解释文档字符串了。

文档字符串(doc str)
在定义函数时,可以在函数内部编写文档字符串,文档字符串就是函数的说明。当我们编写了文档字符串时,就可以通过help()函数来查看函数的说明。文档字符串非常简单,其实直接在函数的第一行写一个字符串就是文档字符串。
我们一般使用一对'''来解释说明。

def fn(a,b,c):
    '''
    这是一个文档字符串的示例

    函数的作用:。。。。。
    函数的参数:
        a,作用,类型,默认值。。。。
        b,作用,类型,默认值。。。。
        c,作用,类型,默认值。。。。
    '''
    return 10

help(fn)

执行结果:

image.png

这个文档字符串不是强制性要求,但是我们应该养成一个良好的习惯,帮助自己理解的同时也可以帮助别人理解。

复杂示例:

def fn(a:int,b:bool,c:str):
    '''
    这是一个文档字符串的示例

    函数的作用:。。。。。
    函数的参数:
        a,作用,类型,默认值。。。。
        b,作用,类型,默认值。。。。
        c,作用,类型,默认值。。。。
    '''
    return 10

help(fn)

执行结果:

image.png

此时假设c有默认值,则可以直接声明:

def fn(a:int,b:bool,c:str='hello')

执行结果:

image.png

我们针对上述代码再次修改,表达返回值类型。

def fn(a:int,b:bool,c:str='hello') -> int:

此时表示的是返回值是int类型。
执行结果:

image.png

对于文档字符串的编写,我们要求一般是用英文进行编写。也根据实际开发情况进行调整。

配套视频课程,点击这里查看

获取更多资源请订阅Python学习站

相关文章
|
15小时前
|
索引 Python
python字符串(str)
【5月更文挑战第8天】
7 3
|
1天前
|
Python 索引 C语言
Python3从零基础到入门(2)—— 运算符-3
Python3从零基础到入门(2)—— 运算符
|
1天前
|
NoSQL 测试技术 API
Python 入门指南(七)(4)
Python 入门指南(七)
9 0
|
1天前
|
测试技术 程序员 数据库
Python 入门指南(七)(3)
Python 入门指南(七)
7 0
|
1天前
|
存储 设计模式 程序员
Python 入门指南(七)(2)
Python 入门指南(七)
9 1
|
1天前
|
XML 算法 uml
Python 入门指南(七)(1)
Python 入门指南(七)
8 0
|
1天前
|
机器学习/深度学习 存储 算法
Python 入门指南(六)(4)
Python 入门指南(六)
6 1
|
1天前
|
设计模式 存储 安全
Python 入门指南(六)(3)
Python 入门指南(六)
9 0
|
1天前
|
存储 缓存 索引
Python 入门指南(六)(2)
Python 入门指南(六)
8 1
|
1天前
|
存储 缓存 程序员
Python 入门指南(六)(1)
Python 入门指南(六)
8 1