您如何修复“缺少模块文档字符串 pylint（缺少模块文档字符串）”

Question

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

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

到json文件的末尾

pygame 问题已解决。但是，当我使用import random 时。我收到此警告：

缺少模块 docstringpylint(missing-module-docstring)

如何让它消失？另外，有没有更好的办法解决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

Answer 2

我刚刚弄清楚文档字符串是什么。它们只是描述函数或类。它用三个双引号或单引号括起来。 This 帮助了我。

为了删除 VSCode 中的文档字符串警告，我刚刚将 "--disable=C0111" 添加到了用户 JSON 设置中的 "python.linting.pylintArgs": []。