前言
npm 是一个用于 Node.js 包管理的开源工具，通过 npm 可以方便的下载、安装以及管理 Node.js 的各种包。而 generator-lerna-jsdoc-packages 是一个为了快速搭建基于 Lerna 多包管理工具，支持 JSdoc 自动生成文档的 npm 包。在前端开发中，使用 npm 包管理工具可以极大的提高开发效率，同时使用 JSdoc 自动生成文档也可以提升代码的可读性和可维护性。
安装与配置
使用 generator-lerna-jsdoc-packages 需要先安装 Generator 和 Yeoman，可以通过以下命令进行安装。
npm install -g yo npm install -g generator-lerna-jsdoc-packages
安装完成后，可通过以下命令创建新项目，并跟随向导完成项目配置。
yo lerna-jsdoc-packages
需要注意的是，generator-lerna-jsdoc-packages 会引导用户进行项目的初始配置，包括项目名称、Lerna 版本、作者信息等。
项目结构
创建完成的项目结构如下：
-- -------------------- ---- ------- - --- -------- - --- -------------- - --- --- - --- --- - --- ---- - --- --- - --- ------------ --- ---------- --- ---------- --- ------------ --- --------- --- ---------
其中，packages 目录下存放的是项目的子包，每个子包都包含了 src 和 test 目录，src 目录存放源代码，test 目录存放测试代码，package.json 存放子包的相关信息，如名称、版本、依赖等。除了 packages 目录外，lerna.json 存放 Lerna 相关配置，如版本号管理等，package.json 存放了整个项目的配置信息，如项目名称、描述、命令等。
快速使用
在项目目录下，可以通过以下常用命令进行操作：
# 安装依赖 yarn install # 同步所有包的依赖 lerna bootstrap # 查看项目版本 lerna version
在创建子包时，generator-lerna-jsdoc-packages 会自动为每个子包安装 JSdoc，同时还会创建以下默认的 npm 命令：
# 生成文档并启动本地服务 npm run doc # 构建打包 npm run build # 运行测试 npm test
示例代码
以下是一个示例代码，为一个简单的加法函数实现，并自动生成 JSdoc 类型文档。
-- -------------------- ---- ------- --- - --- --- -------- - ------ -------- - --- ----- ------ -- ---- - ------ -------- - --- ------ ------ -- ---- - -------- -------- --- --- -- - --- -- -- -------- ------ -- - ------ - - -- - -------------- - ----
总结
generator-lerna-jsdoc-packages 是一个值得推荐的多包管理工具，其快速搭建和文档生成功能，可以大大提高前端开发效率。本文对使用 generator-lerna-jsdoc-packages 进行项目管理进行了详细的介绍，同时通过示例代码，演示了使用 JSdoc 自动生成文档的流程，希望对前端开发者有所启发。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/600671a630d0927023822546