Missing module docstring pylint

三毛呀

已于 2023-07-08 15:03:15 修改

阅读量2.8k

点赞数 2

文章标签： vscode python

于 2023-07-08 15:01:37 首次发布

本文链接：https://blog.csdn.net/ruanha111/article/details/131612120

版权

文章介绍了在VSCode中遇到pylint插件导致代码出现波浪线问题的解决方案。可以通过禁用或卸载pylint插件，或者修改settings.json文件，添加特定参数来禁用特定警告，如missing-module-docstring等。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

Missing module docstring pylint

在 VSCode 中，遇到代码经常会出现波浪线的问题，影响美观和心情。如图：

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-wSXOwSjF-1688799523275)(Missing module docstring pylint.assets/image-20230708115542084.png)]

发现是 pylint 的问题。

pylint 作用：日常开发中，不同开发人员会写下不同风格的代码，导致代码可维护性变差，为了解决风格不一致问题，可以制定代码规范。pylint 可以自动检查代码，识别并自动修改部分错误，自动补齐，使得代码更加规范。

有以下两种解决方法：

禁用或卸载 pylint 插件。
修改 settings.json 文件，此时仍然使用 pylint 插件。

禁用或卸载 `pylint` 插件

选择左侧的 拓展 (Extensions) 按钮
搜索框输入 pylint
选择 禁用 (Disable) 或者 卸载 (Uninstall)
最后，点击 重新加载 (Reload Required)

在这里插入图片描述

修改 `settings.json` 文件

打开命令面板：Mac 快捷键 Command + Shift + P ，Windows 快捷键 Ctrl + Shift + P 。
输入 setting ，选择 Prefernce: Open User Settings(JSON) ：

在这里插入图片描述

在 JSON 文件中加入如下代码：

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

如图：

然后保存即可。

Missing module docstring pylint

Missing module docstring pylint

禁用或卸载 pylint 插件

修改 settings.json 文件

禁用或卸载 `pylint` 插件

修改 `settings.json` 文件