当前位置: > python问答 >

文档字符串和注释的区别
栏目分类:python问答   发布日期:2019年07月10日 11:23:43   浏览次数:

当我们在开发一个程序,可者是写完很多代码,回过头看代码的时候,你就知道有什么用了,也有可能过一段时间,可能就不记得这些代码是干什么的了,为了提高可读性,这个时候就能体现到注释的好处了,不管是自己看,还是给别人看,都会变得容易,但是在学习python的时候,除了注释,还有文档字符串,都能够方便代码阅读,那二个的区别是什么呢?
如果代码开放,你能够拿到源代码,这个时候只要编写好了注释,别人也很容易看得懂,但如果代码不给你怎么办呢?只给你说有一个sum方法,就不会有了吧,所以在python中,提供help函数来查看用法,来看下面的案例

文档字符串和注释的区别

 


#定义一个求和的函数
def sum(a,b):
    '''
    这是一个文档字符串的说明:

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

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

    '''
    print("输入二个数的和",a+b) #这里打印一下a和b的和
sum(2,3)
print('下面在来用help函数来查看上面自定义的函数如下:')
help(sum)
结果:
输入二个数的和 5
下面在来用help函数来查看上面自定义的函数如下:
Help on function sum in module __main__:
 
sum(a, b)
    这是一个文档字符串的说明:
    
    函数的作用:求二个数的和
    
    参数:a,b的类型是整形
    ......
    ......


从上面的结果来看,注释是看不到的,如果编写的函数有文档字符串,那我们就可以很容易的操作这个函数了,
所以在学习python时,你要学习大量的内建函数,如input,print,id,type

相关热词:

热门关键词
python字符串
     
python教程 python爬虫 python人工智能 Python+大数据 python问答