VSCode插件开发中的中文命名规范插件

星婷吖_5493

星婷吖_5493

2026-10-06

206人浏览

原创

插件中命令或配置项的key必须为ascii字符,中文命名会导致静默失效;用户可见的中文名称需通过package.nls.json本地化文件配合英文key实现。

vscode插件开发中的中文命名规范插件

为什么插件里用中文命名命令或配置项会失效

VSCode 的插件系统对 command、contributes 中的 key(如 command ID、configuration 属性名)强制要求 ASCII 字符,不允许直接使用中文。一旦在 package.json 的 contributes.commands 或 contributes.configuration.properties 里写 "命令名称": {...},VS Code 启动时会静默忽略该条目,调试窗口看不到注册日志,Ctrl+Shift+P 也搜不到——不是报错,而是根本没加载。

  • 命令 ID 必须是小写字母、数字、连字符和点号组合,例如 "my-extension.say-hello",不能含中文、空格、下划线或大写字母
  • 配置项 key 同样受限,"myExtension.启用中文提示" 会解析失败;正确写法是 "myExtension.enableChineseHint"
  • 语言包(package.nls.json)才是放中文的地方:把用户看到的“显示欢迎消息”映射到英文 key 上

如何让命令面板显示中文名称

命令本身 ID 必须英文,但用户看到的标题可以是中文——靠 package.nls.json + package.json 联动实现。这是唯一合规且稳定的方式。

  • 在 package.json 的 contributes.commands 中写英文 ID 和占位符描述:
    "commands": [{ "command": "my-extension.show-welcome", "title": "%welcome.title%", "category": "%welcome.category%" }]
  • 新建 package.nls.json(根目录),写:
    { "welcome.title": "显示欢迎消息", "welcome.category": "我的插件" }
  • 如果还要支持英文用户,再建 package.nls.zh-cn.json 和 package.nls.en-us.json,VS Code 会自动按系统 locale 加载对应文件

插件配置项(settings)里怎么支持中文说明

配置项的 description 和 properties 的 description 字段,同样必须通过 nls 文件翻译,不能硬编码中文字符串。

VSCode
VSCode

避免常见的 VSCode 错误——设置冲突、调试器配置和扩展冲突。

下载
  • package.json 中这样写:
    "configuration": { "type": "object", "properties": { "myExtension.enableLog": { "type": "boolean", "default": true, "description": "%enableLog.description%" } } }
  • 对应 package.nls.json 添加:
    "enableLog.description": "启用操作日志输出"
  • 注意:VS Code 读取 package.nls.json 时默认用 UTF-8 编码,保存时务必禁用 BOM,否则中文乱码或整个文件被跳过

调试时中文提示不显示?检查三个硬性条件

即使写了 nls 文件,中文仍不出现,大概率卡在这三个地方:

  • package.nls.json 文件名拼写错误,必须是全小写、带点号、无空格:package.nls.json ✅,package.nls.zh.json ❌(应为 package.nls.zh-cn.json)
  • 插件未重新激活:改完 nls 文件后,必须重启插件宿主窗口(按 Ctrl+Shift+P → Developer: Reload Window),仅重载扩展无效
  • locale 设置未生效:宿主 VS Code 的 locale 不是 "zh-cn",可在 settings.json 确认,或运行 Configure Display Language 命令再选一次

真正生效的只有 package.nls.*.json + 英文 key + 正确 locale 三者闭环,任何一环断开,中文就出不来。别试图在代码里拼接中文字符串覆盖 UI 文本,那会绕过本地化机制,且被 VS Code 版本更新反复破坏。

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
vscode是什么_vscode怎么安装配置
vscode是什么_vscode怎么安装配置

VS Code(Visual Studio Code)是一款免费、开源的跨平台代码编辑器,由微软开发和维护。它被广泛用于软件开发和编程,支持多种编程语言和框架。VS Code 同时提供了丰富的功能和扩展性,使开发者可以高效地编写、编辑和调试代码。

2023.06.30

1255

18

vscode怎么运行代码
vscode怎么运行代码

vscode是一个运行于MacOS X、Windows和Linux之上的,针对于编写现代Web和云应用的跨平台源代码编辑器;vscode免费而且功能强大,对JavaScript和NodeJS的支持非常好,自带很多功能,例如代码格式化,代码智能提示补全、Emmet插件等。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

2023.07.21

2592

3

vscode使用的框架介绍
vscode使用的框架介绍

VSCode是一款跨平台代码编辑器,它基于Electron框架和Monaco Editor构建。想了解更多vscode的相关内容,可以阅读本专题下面的文章。

2024.03.14

1889

12

vscode一般用来写什么语言
vscode一般用来写什么语言

VSCode是一款功能强大的代码编辑器,支持多种编程语言和文件格式。它内置对 JavaScript、Python、Java、C++、TypeScript、HTML/CSS、Go 等语言的支持。想了解更多vscode的相关内容,可以阅读本专题下面的文章。

2024.03.14

1707

8

vscode可以写什么语言
vscode可以写什么语言

vscode是一款强大的代码编辑器,支持多种编程语言的开发。通过安装扩展,可以为 JavaScript/TypeScript、Python、Java、C#、PHP、Go、Ruby、Rust、HTML/CSS 等语言提供智能代码补全、调试和格式化等功能。想了解更多vscode的相关内容,可以阅读本专题下面的文章。

2024.03.15

2587

12

vscode中文设置方法
vscode中文设置方法

方法一:在设置页面中,搜索“locale”,并选择“zh-cn”。方法二:按“Ctrl Shift P”快捷键,输入“Configure Display Language”,将语言修改为“zh-cn”。如果上述方法无效,可考虑安装中文插件。想了解更多vscode的相关内容,可以阅读本专题下面的文章。

2024.03.15

1798

14

vscode用途介绍
vscode用途介绍

Visual Studio Code(VSCode)是一款由 Microsoft 开发的多功能文本编辑器,适用于各种编程语言。作为一款开源软件,VSCode 拥有代码高亮、自动补全、调试、Git 集成等强大功能,成为程序员不可或缺的工具。想了解更多vscode的相关内容,可以阅读本专题下面的文章。

2024.03.15

1242

10

vscode和visualstudio的区别
vscode和visualstudio的区别

Visual Studio是一款功能强大的集成开发环境(IDE),适用于专业开发人员进行复杂项目的构建。而VSCode则是一款轻量级的代码编辑器,更适合各种规模的项目开发。想了解更多vscode的相关内容,可以阅读本专题下面的文章。

2024.03.15

1096

8

vscode设置中文界面不生效解决方法
vscode设置中文界面不生效解决方法

vscode设置中文界面不生效解决方法:安装中文语言包、通过命令面板设置语言、检查 locale.json 设置、重新安装中文语言包、检查 VSCode 版本和更新、排除插件冲突、检查系统语言设置、查看 VSCode 日志和错误消息、重置 VSCode 设置、查看官方文档和社区支持。想了解更多vscode的相关内容,可以阅读本专题下面的文章。

2024.03.15

454

5

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程