Missing module docstring pylint
在 VSCode 中,遇到代码经常会出现波浪线的问题,影响美观和心情。如图:
发现是 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"
],
如图:
然后保存即可。