VSCode插件开发插件中文说明书生成

胖浩姑娘_1740

胖浩姑娘_1740

2026-08-27

1018人浏览

原创

vs code 插件中文说明书需手动编写 readme.md、package.json 中的 displayname 和 description 字段,并配合 package.nls.zh-cn.json 实现运行时本地化;displayname 与 description 可直写中文但仅用于市场页显示,命令/菜单等运行时文案必须通过 .nls.json 文件定义键值,且需与代码中 vscode.l10n.t() 调用完全一致。

vscode插件开发插件中文说明书生成

插件开发时中文说明书怎么生成

VS Code 官方不提供插件说明书的自动生成工具,所谓“中文说明书”实际是开发者手动编写的 README.mdpackage.json 中的 descriptiondisplayName 字段,以及可选的本地化语言包(package.nls.zh-cn.json)三者共同构成。没有一键生成,但有明确路径可走。

package.json 里的中文字段怎么填才生效

displayNamedescription 支持中文直写,但仅影响扩展市场页和 VS Code 扩展面板显示;它们不会被翻译,也不参与运行时本地化。关键点:

  • displayName:显示在扩展列表顶部,建议控制在 20 字以内,避免换行错位
  • description:显示在扩展面板详情区,建议 120 字内,过长会被截断(VS Code UI 限制)
  • 不要在 package.json 中写 locale 字段——那是用户端设置,不是插件配置项
  • 如果用了国际化(i18n),这些字段应改为 %displayName% 形式,并在 package.nls.json 中定义对应键值

如何让命令、菜单、提示文字显示中文

package.nls.zh-cn.json 文件实现运行时本地化,VS Code 启动时根据用户 locale 设置自动加载。常见坑:

VSCode
VSCode

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

下载
  • 文件必须放在 package.nls.json(默认)或 package.nls.zh-cn.json(简体中文专用),不能放错目录
  • 键名必须与 package.json 或代码中调用的 vscode.l10n.t() 参数完全一致,大小写敏感
  • 命令标题(contributes.commands.title)、菜单项(contributes.menus)、设置项描述(contributes.configuration.properties.*.description)都需在此文件中定义
  • 未定义的键会 fallback 到英文原文,不会报错,但用户看到的就是英文——这是最常被忽略的失效原因

vscode.l10n.t() 和旧版 localize() 怎么选

VS Code 1.83+ 推荐用 vscode.l10n.t(),它支持模块级作用域和更精准的上下文提取。旧版 vscode.env.language + 手动查表方式已不推荐:

  • vscode.l10n.t("Hello") → 自动匹配当前 locale,无需判断语言环境
  • 若仍用 localize()(来自 vscode-nls),需确保构建时执行 nls-build 提取键值,否则 .nls.json 文件为空
  • 调试时发现中文没出来?先检查终端输出是否有 Missing translation for key: xxx,这是最直接的线索
  • 注意:Webview 内部的字符串不走 l10n.t(),需显式传入本地化文本或通过 vscode.postMessage 注入

真正难的不是写中文,而是让所有散落在 package.json、代码字符串、Webview 模板、甚至贡献点(contributes)里的文案全部对齐到同一套键值体系。漏掉任意一处,用户就会在某个角落看到突兀的英文。

相关文章

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

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

下载

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

相关专题

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

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

2023.06.30

1155

18

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

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

2023.07.21

2272

3

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

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

2024.03.14

1789

12

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

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

2024.03.14

1587

8

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

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

2024.03.15

2487

12

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

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

2024.03.15

1758

14

vscode用途介绍
vscode用途介绍

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

2024.03.15

1202

10

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

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

2024.03.15

1076

8

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

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

2024.03.15

414

5

热门下载

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

精品课程

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