缺失或空docstring是什么鬼?

经常看到“缺失或空docstring”这样的错误提示。那么,缺失或空docstring是什么鬼?

我们来看,pycharm给出的示例:


报告缺失的和空的 docstring。
缺失 docstring 的示例
def demo(a):
    c = a ** 2
空 docstring 的示例
def demo(a):
    """
    """
    c = a ** 2
应用快速修复后,这段代码变为:
def demo(a):
    """

    :param a:
    """
    c = a ** 2
您需要提供一些有关所生成模板中的形参的详细信息。

我们看完了示例之后,就明白:是在定义函数时,缺失了关于函数的说明文档,或者是说明文档内容为空。

  • 7
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值