PyCharm切换至Google/Numpy等文档字符串格式后无高亮问题求助
解决PyCharm非reStructuredText格式文档字符串高亮问题
一、安装第三方补全插件
PyCharm默认仅对reStructuredText风格的文档字符串关键词提供高亮,Google、Numpy等格式需要借助插件补足支持:
- 打开PyCharm的
Settings > Plugins - 在Marketplace搜索Google Docstrings Support或Docstring Format,选择适配性高的插件安装,重启PyCharm生效
二、匹配插件与文档字符串格式
插件安装完成后做以下配置:
- 回到
Settings > Tools > Python Integrated Tools > Docstrings,确认Docstring format已设置为你需要的Google/Numpy样式 - 进入插件专属设置页(通常在
Settings > Tools下对应插件选项),开启语法高亮功能
三、自定义语法高亮规则(进阶方案)
如果插件效果不理想,可以手动添加高亮规则:
- 打开
Settings > Editor > Color Scheme > Python - 找到
Docstrings分类,点击右侧+号添加自定义规则 - 针对Google/Numpy格式的关键词(如
Args:、Returns:、Raises:)编写匹配正则,再配置对应的高亮颜色和样式
四、测试验证
创建测试函数生成对应格式文档字符串,检查关键词高亮效果:
def add(a, b): """计算两个数字的和。 Args: a (int): 第一个数字 b (int): 第二个数字 Returns: int: 两个数字的和 Raises: TypeError: 输入非整数时触发 """ if not isinstance(a, int) or not isinstance(b, int): raise TypeError("输入必须为整数") return a + b
内容的提问来源于stack exchange,提问作者Jack Zhang
相关产品推荐
相关产品推荐

