问如何在Pylint中禁用文件级的"missing docstring“警告？

EN

Python模块有一个文档字符串是很好的，它解释了模块做什么，它提供了什么，以及如何使用这些类的示例。这与你经常在文件开头看到的给出版权和许可证信息的注释不同，IMO不应该在文档字符串中列出这些信息(一些人甚至认为它们应该完全消失，参见例如)。

在Pylint2.4及以上版本中，您可以使用以下三个子消息来区分不同的missing-docstring：

• C0114 (missing-module-docstring)
• C0115 (missing-class-docstring)
• C0116 (missing-function-docstring)

因此，下面的.pylintrc文件应该可以工作：

[MASTER]
disable=
    C0114, # missing-module-docstring

对于早期版本的Pylint，对于文档字符串可能出现的各种位置，它没有单独的代码，因此您所能做的就是禁用C0111。问题是，如果你在模块作用域中禁用它，那么它在模块中的任何地方都会被禁用(即，你不会因为缺少函数/类/方法docstring而得到任何C行。这可不是件好事。

因此，我建议添加缺少的小文档字符串，如下所示：

"""
high level support for doing this and that.
"""

很快，您就会发现可以放入其中的有用内容，例如提供如何使用模块的各种类/函数的示例，这些类/函数不一定属于类/函数的单个文档字符串(例如这些类/函数如何交互，或者像快速入门指南之类的东西)。

我找到了这个here。

您可以为Pylint添加“--errors only”标志以禁用警告。

要执行此操作，请转到设置。编辑以下行：

"python.linting.pylintArgs": []

作为

"python.linting.pylintArgs": ["--errors-only"]

你就可以走了！

我认为在不禁用此功能的情况下修复相对容易。

def kos_root():
    """Return the pathname of the KOS root directory."""
    global _kos_root
    if _kos_root: return _kos_root

您所需要做的就是在每个函数中添加三重双引号字符串。