你如何解决“缺少模块文档字符串pylint（缺少模块文档字符串）”

Question

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

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

到json文件的末尾

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

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

我该如何让它消失？另外，有没有更好的方法来解决pygame的init问题？

谢谢！

Answer 1

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

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

Answer 2

此答案已使用扩展的文档进行更新，在 vscode 的 settings.json 中添加以下代码

"pylint.args": [
    "--disable=missing-module-docstring",
    "--disable=missing-class-docstring",
    "--disable=missing-function-docstring"
],

这将禁用模块、类和函数文档字符串的警告

参考：扩展的文档

Answer 3

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 4

我在 VsCode 中添加了以下设置以禁用所有文档字符串警告。

"python.linting.pylintArgs": [
  "--disable=missing-module-docstring",
  "--disable=missing-class-docstring",
  "--disable=missing-function-docstring"
]