经常看到“缺失或空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
您需要提供一些有关所生成模板中的形参的详细信息。
我们看完了示例之后,就明白:是在定义函数时,缺失了关于函数的说明文档,或者是说明文档内容为空。