如何在VSCode中通过快捷键显示类级别的Docstring?
如何在VSCode中通过快捷键显示类级别的文档字符串(Docstring)
有些类的文档字符串(Docstring)会定义在类级别,而非__init__等方法内部(例如PyTorch的CrossEntropyLoss类),以下是在VSCode中通过快捷键显示这类类级Docstring的操作方法:
第一步:确认安装VSCode官方Python插件
该插件是实现代码提示、文档解析的基础,若未安装,直接在插件市场搜索"Python"安装即可。第二步:配置自定义快捷键
- 按下
Ctrl+K Ctrl+S(Windows/Linux)或Cmd+K Cmd+S(Mac)打开快捷键设置面板; - 在搜索框中输入
show docstring,找到Python: Show Docstring命令; - 点击该命令旁的铅笔图标,输入你想要绑定的快捷键(比如
Ctrl+Q,注意避开已有快捷键冲突),按下回车确认。
- 按下
第三步:触发类级Docstring显示
将光标定位到类的名称上(可以是类定义行的类名,也可以是代码中实例化该类的对象名),按下你设置好的快捷键,就能直接调出类级别的Docstring内容。可选优化配置
若文档显示格式不符合预期,可打开VSCode设置(快捷键Ctrl+,/Cmd+,),搜索Python > IntelliSense: Docstring Format,选择对应格式(如Google、NumPy),确保类级Docstring能被正确解析展示。
内容的提问来源于stack exchange,提问作者Anil
相关产品推荐
相关产品推荐

