为何Visual Studio Code中/**开头的注释内代码仍会被语法高亮?
现象原因
VS Code的语法高亮系统会主动区分普通块注释和文档注释两类格式:
- 以
/**开头的注释属于编程语言通用的文档注释约定(最常见的是JSDoc规范),编辑器识别到该标识后,会对注释内部的变量、类型标注、标签等符合文档注释规则的内容做语义解析和单独高亮,方便开发者快速识别文档中的关键信息,所以你会看到注释内的部分变量仍保留高亮效果。 - 以
/*开头的是原生普通块注释,编辑器默认仅将整段内容标记为普通注释,不会做额外的语义解析,因此整段内容统一显示为注释样式,无额外高亮。
两种注释格式的核心区别
- 定位不同:
/*是语言原生定义的普通多行注释,作用仅为标记内容不需要参与编译/执行,内部没有统一规范;/**是业界通用的文档注释约定,专门用于给函数、类、变量编写开发说明,配套的工具链可以直接从这类注释中提取信息生成API文档。 - 工具支持不同:普通注释只会被标记为注释类格式,不会被其他工具额外解析;文档注释会被IDE、代码检查工具、文档生成工具主动识别,除了内部内容高亮外,还支持悬停展示文档、参数自动补全提示、类型校验等额外功能。
- 使用场景不同:临时注释废弃代码、写内部临时备注时用
/*;给对外暴露的方法、类、变量编写公开说明时用/**。
对比截图
- 以
/**开头的块注释效果:
- 删除一个*后的块注释效果:

内容的提问来源于stack exchange,提问作者user16665581
相关产品推荐
相关产品推荐

