Python函数的注释应该用引号而不是#

Python函数的注释应该用引号而不是#,第1张

我们知道Python的注释有两种:#和引号(包含单引号、双引号、三个引号连用)。

但是在给函数注释时应该使用引号(三种都可以)而不是#,原因如下:

引号内的注释相当于函数的文档字符串,可以用函数名.__doc__访问,例如:

def hhh():
    """打印哈哈哈"""
    print('hhh')

print(hhh.__doc__)

输出:

打印哈哈哈

如果用#注释则无法查看注释:

def hhh():
    #打印哈哈哈
    print('hhh')
    
print(hhh.__doc__)

输出:

None

此外,使用pycharm等ide时,不管是定义时还是调用时,将鼠标停留在函数名称上,引号内的注释都会显示出来,便于快速查询,不用跳转后查看:

欢迎分享,转载请注明来源:内存溢出

原文地址: https://outofmemory.cn/langs/786333.html

(0)
打赏 微信扫一扫 微信扫一扫 支付宝扫一扫 支付宝扫一扫
上一篇 2022-05-05
下一篇 2022-05-05

发表评论

登录后才能评论

评论列表(0条)

保存