如何让VS Code在Python重构时同步重命名文档字符串中的符号？

核心解决方法 #

VS Code默认的Python重构功能（基于Pylance）本身不支持文档字符串内的符号同步更新，但可以通过以下两种方式实现类似PyCharm的效果：

1. 开启Pylance的文档字符串重构支持 #

Pylance的新版本已经添加了文档字符串内参数名同步重命名的功能，只需手动开启配置：

• 打开VS Code设置（快捷键Ctrl+,/Cmd+,）
• 搜索Python > Analysis: Rename Refactor Include Docstrings
• 勾选该选项，或者直接在settings.json中添加配置：

  "python.analysis.renameRefactorIncludeDocstrings": true
  

开启后，使用F2重命名函数参数、变量等符号时，Pylance会自动同步更新Google风格、NumPy风格、reStructuredText风格文档字符串里的对应名称。

2. 借助第三方插件增强能力 #

如果Pylance的原生支持无法满足需求，可以尝试专用插件：

• Python Docstring Generator：除了生成文档字符串，部分版本可配合Pylance实现文档内符号的同步重构
• Rename Docstrings：专门针对文档字符串的重命名同步插件，安装后重命名符号时会自动触发文档内的名称更新

注意事项 #

• 确保VS Code和Python插件（Pylance）为最新版本，旧版本可能没有文档字符串重构功能
• 不同风格的文档字符串支持程度有差异，Google风格和NumPy风格的兼容性最好，自定义风格可能无法被识别
• 你之前使用的autodocs仅为高亮工具，不会影响重构功能，开启Pylance的配置后即可覆盖原有行为

内容的提问来源于stack exchange，提问作者Vitor Matias