VS Code中Pylance未识别Python类文档字符串Methods段怎么办?
解决VSCode中Google风格文档字符串Methods章节不高亮的问题
你遇到的情况是因为VSCode的Python语言服务(Pylance/Pyright)默认只把Attributes、Args、Returns这类章节标记为标准可识别的文档字符串章节,Methods不在默认列表里,但可以通过自定义配置解决:
- 自定义Pylance的文档字符串章节
- 打开VSCode设置(按
Ctrl+,) - 在搜索框输入
Pylance > Python: Docstring Section Tags - 点击"编辑 in settings.json",把
"Methods"添加到数组中,示例配置如下:"python.analysis.docstringSectionTags": [ "Args", "Returns", "Raises", "Attributes", "Methods" ] - 保存配置后重启VSCode,悬停类名时Methods章节就会被识别并高亮了。
- 打开VSCode设置(按
另外,Google风格指南里类的文档字符串用Methods作为章节标题是合规的,并非标题错误,只是VSCode默认未支持这个自定义章节而已。
内容的提问来源于stack exchange,提问作者Alberto Jiménez
相关产品推荐
相关产品推荐

