python - 你如何修复 "Missing module docstringpylint(missing-module-docstring)"

Question

我在 VSCode 上使用 pygame 模块，但遇到了 pygame 没有 init 成员的问题。我遵循了 this 的解决方案关联。我编辑了用户设置并添加了

    "python.linting.pylintArgs": [
        "--extension-pkg-whitelist=pygame",
        "--unsafe-load-any-extension=y"
    ]

到json文件的末尾
pygame 问题已解决。但是，当我使用 import random 时.我收到此警告:
缺少模块文档字符串pylint(缺少模块文档字符串)
我该如何让它消失？另外，有没有更好的方法来解决pygame的init问题？
谢谢!

Answer 1

python 模块的文档字符串记录了该文件的内容。
您可以通过在模块顶部添加文档字符串来解决此错误:

"""
Provides some arithmetic functions
"""

def add(a, b):
  """Add two numbers"""
  return a + b

def mult(a, b): 
  """Multiply two numbers"""
  return a * b

阅读更多 https://www.python.org/dev/peps/pep-0257/#multi-line-docstrings