你如何修复“缺少模块 docstringpylint(missing-module-docstring)”

Question

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

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

到json文件的末尾

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

缺少模块 docstringpylint（缺少模块文档字符串）

我怎样才能让它消失？还有，有没有更好的办法解决pygame的init问题？

谢谢！

原文由 Kyle Angelo Gonzales 发布，翻译遵循 CC BY-SA 4.0 许可协议

Answer 1

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

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

原文由 Kyle Angelo Gonzales 发布，翻译遵循 CC BY-SA 4.0 许可协议

Answer 2

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 阅读更多内容

原文由 Benny Powers 发布，翻译遵循 CC BY-SA 4.0 许可协议