VS Code中Python代码出现Missing module docstring波浪线如何关闭?
关闭VS Code中Python "Missing module docstring"提示的方法
这个提示是Python静态代码检查工具(默认多为Python扩展自带的Pylance,部分用户会使用Pylint)触发的文档字符串规范类提示,可按以下对应方法关闭:
如果你使用Pylance(默认安装Python扩展后使用的检查工具)
- 打开VS Code设置页:快捷键为
Ctrl+,(Windows/Linux系统)或Cmd+,(Mac系统) - 在顶部搜索框输入
python.analysis.diagnosticSeverityOverrides,找到对应配置项后点击「在settings.json中编辑」 - 在打开的json文件中添加如下规则:
"python.analysis.diagnosticSeverityOverrides": { "reportMissingModuleDocstring": "none", // 若同时需要关闭函数、类缺失文档字符串的提示,可追加以下两行配置 "reportMissingFunctionDocstring": "none", "reportMissingClassDocstring": "none" }
保存文件后提示就会消失。
如果你使用Pylint作为代码检查工具
- 打开项目根目录下的
.pylintrc配置文件,若不存在可直接新建该文件 - 找到
[MESSAGES CONTROL]区块下的disable配置项,追加missing-docstring即可,示例如下:
[MESSAGES CONTROL] disable=missing-docstring
- 若仅需要关闭模块级的文档字符串检查,不想关闭函数、类的同类提示,可追加错误码
C0114即可(类缺失文档字符串错误码为C0115,函数缺失文档字符串错误码为C0116)
对应问题截图:
内容的提问来源于stack exchange,提问作者Baba
相关产品推荐
相关产品推荐

