当你编写前端代码时，如何有效地记录你的代码以及给其他开发人员带来极大的便利？这时候 jsdoc 就会派上用场。
jsdoc 作为前端开发中一款高效、简单的 API 文档生成工具，可以将你的代码注释自动化为 API 文档。同时，npm 包 jsdoc-i18n 可以让你的 API 文档支持多语言。
本文将为你详细介绍如何使用 npm 包 jsdoc-i18n。
安装
使用 npm 安装 jsdoc-i18n：
npm install jsdoc-i18n
配置
注释格式
可以使用 jsdoc 支持的注释格式，例如 JSDoc、Google Closure Annotaions 等。以 JSDoc 为例：
/**
* 这是一个演示方法的例子
* @param {number} x - 参数 x。
* @returns {number} 返回加 1 后的值
*/
function increment(x) {
return x + 1;
}配置 jsdoc
在项目根目录下创建配置文件 jsdoc.json 并加入以下内容：
-- -------------------- ---- -------
-
--------- -
---------- --------
----------------- ----------
--
---------- -
------------------
--
------- -
-------------- --------
----------- -------
---------- -----
----------- ------------------------------------
------------ -------------
---------- -----
---------- -----
---------- ----
-
-配置 jsdoc-i18n
在项目根目录下的 jsdoc.json 中加入以下内容：
-- -------------------- ---- -------
-
--------- -
---------- --------
----------------- ----------
--
---------- -
-------------------
---------------------------------------
--
------- -
-------------- --------
----------- -------
---------- -----
----------- ------------------------------------
------------ -------------
---------- -----
---------- -----
---------- -----
--------- ----
--
------- -
---------- ------ -----
-
-在 options 中新增了 locale 参数。如果没有指定该参数，则默认为 en。在 i18n 中设置了可选的语言。
编写语言文件
在 i18n/ 目录下创建一个名为 en.json 的 JSON 文件，填写以下内容：
{
"foo": "foo",
"bar": "bar"
}在 i18n/ 目录下创建一个名为 zh.json 的 JSON 文件，填写以下内容：
{
"foo": "中文foo",
"bar": "中文bar"
}现在，我们已经可以使用多语言了！
使用
在命令行中输入以下命令：
npx jsdoc -c jsdoc.json
在 docs/ 目录下可以找到生成的文档。
在显示本地化文本时使用 {{#if}}...{{/if}} 和 {{#each}}...{{/each}}。示例代码如下：
-- -------------------- ---- -------
--------- -----
----- ----------
----- ----
------
----- ----------------
--------- -------- ----------
-------
-------
------
------ ------- -------
------- ---------
------ --------- -------
----
------- --------------
------ ---- -------
---------
-----
---------
-------
-------这样，编写的文档就能够进行多语言切换了。
结论
在你需要阅读和编写文档的前端项目中，jsdoc 帮助你减轻很多负担，更好地管理你的代码库。选择 jsdoc-i18n，则能够轻松地为你的项目添加多语言支持。
使用 jsdoc-i18n 可以为你的文档带来很多便利，上面的配置和代码示例应该能够带你起步。祝你好运！
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/6005596481e8991b448d6e21