VS Code 1.76.2中Python函数返回类型注解致注释变色的原因及修复

问题描述 #

为Python函数sum2添加-> int返回类型注解后，VS Code 1.76.2里的注释# test不再显示为绿色高亮，代码示例如下：

def sum2(a: int, b:int) -> int:
    # test
    return a + b

print(sum2(2,3))

原因分析 #

这是VS Code 1.76.2自带的Python语法高亮解析器的bug——当函数定义包含返回类型注解时，解析器无法正确识别函数体内紧跟函数定义行的首行注释，误将其判定为代码的一部分，因此没有应用注释的高亮样式。

修复方法 #

• 升级VS Code版本：该bug在VS Code 1.77及后续版本中已被官方修复，直接升级IDE即可解决问题。
• 更换语法高亮插件：安装第三方Python语法高亮插件（比如Python Syntax Highlighting），替代默认的解析器，能正确识别此类场景下的注释。
• 临时调整注释位置：如果暂时无法升级或更换插件，可在注释前添加一个空行，让默认解析器正确识别注释：

  def sum2(a: int, b:int) -> int:
  
      # test
      return a + b
  

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