如何消除VS Code中Python的Docstring警告（蓝色波浪线）

问题描述 #

我正在学习Python编程，常用IDE为Visual Studio Code。目前遇到问题：每个函数和变量下方都会出现Docstring警告（蓝色波浪线）。我找到一个临时解决方案，即在文件顶部添加以下代码：

# pylint: disable=missing-module-docstring
# pylint: disable=missing-class-docstring
# pylint: disable=missing-function-docstring
# pylint: disable=invalid-name
# pylint: disable=trailing-newlines
# pylint: disable=trailing-whitespace
# pylint: disable=missing-final-newline

但这种方式既繁琐又不专业。我已尝试解决两天，甚至按照指导在settings.json中添加"python.linting.pylintArgs": ["--disable=C0111"]，但不确定操作是否正确，特来求助。

解决方案 #

方法一：VSCode全局配置永久禁用指定警告 #

1. 按Ctrl+,（Windows/Linux）或Cmd+,（Mac）打开设置界面。
2. 搜索Python > Linting: Pylint Args，点击编辑 in settings.json。
3. 在settings.json中补充或替换为以下配置：

"python.linting.pylintArgs": [
    "--disable=C0111", // 覆盖模块、类、函数的docstring缺失警告
    "--disable=C0103", // 禁用无效命名警告
    "--disable=C0303", // 禁用末尾换行警告
    "--disable=C0305", // 禁用缺失末尾空行警告
    "--disable=C0302"  // 禁用尾随空格警告
]

注：C0111规则已包含模块、类、函数的docstring缺失场景，无需单独添加三个disable项。

4. 保存settings.json，重启VSCode后配置生效。

方法二：项目级Pylint配置文件（推荐） #

若只需当前项目生效，无需全局修改：

1. 在项目根目录创建.pylintrc文件。
2. 写入以下内容：

[MESSAGES CONTROL]
disable=
    C0111, # missing docstring
    C0103, # invalid name
    C0303, # trailing newlines
    C0305, # missing final newline
    C0302  # trailing whitespace

3. 保存文件后，VSCode会自动读取该配置，无需额外操作。

配置验证 #

修改后打开有警告的Python文件，蓝色波浪线应消失。若仍有问题：

• 确认Python > Linting: Enabled和Python > Linting: Pylint Enabled已勾选。
• 重启VSCode确保配置完全加载。

内容的提问来源于stack exchange，提问作者Lucas Saez kiekebusch