doxie-core 是一个用于创建文档和文档注释的 npm 包。它接收 JavaScript 文件（包括 .js 和 .jsx 文件），提取其注释并生成文档。该包可以使用在 Web 开发，代码文档和代码分享等场景中。
在本文中，我们将介绍如何使用 doxie-core 包，包括包的安装过程、使用前的准备工作、以及如何对 JavaScript 文件进行文件提取和文档生成。
安装 doxie-core 包
首先，需要在本地安装 doxie-core 包，安装命令：
npm install doxie-core
安装成功后，可以使用以下方式确认安装是否成功：
doxie-core --version
输出：doxie-core: <version>`。
使用前的准备工作
在开始使用 doxie-core 之前，需要保证以下条件：
- 目标 JavaScript 文件存储在本地。
- 目标 JavaScript 文件中存在包含代码注释的部分。
符合以上要求后，即可开始对 JavaScript 文件进行注释抽取和文档生成。
提取注释并生成文档
使用 doxie-core 可以很方便地从 JavaScript 文件中提取注释并生成文档。下面我们将介绍如何进行文件提取和文档生成。
首先，创建一个名为 sample.js 的 JavaScript 文件，其中包含一些注释。示例代码如下：
-- -------------------- ---- ------- --- - -- ---------- ------ - -------- ---------- ----------- ---------- ------ -- --- - --- - - ---- - ------ -------- - - ---- - ------ -------- - - ---- - -------- -------- ---- -- -------- ------ -- - ------ - - -- -
使用以下命令进行注释抽取和文档生成：
doxie-core -i ./sample.js -o ./docs
以上命令对 sample.js 中的内容进行注释抽取，并将生成的文档输出到 ./docs 目录中。
再次运行生成命令，如果没有修改源文件的注释和文档，将会生成相同的文档。如果要重新生成文档，可以使用 --overwrite 选项。
注释格式
在 JavaScript 文件中，注释的格式是 /** ... */，其中第一个星号必须紧贴注释的起始位置，否则将不能被解析为注释（而只是普通的字符串）。注释的其他部分应编写在星号后面。
注释的第一行是概述。在 doxie-core 中，概述应包括函数或类的名称和简要描述。
接下来的每一行应该描述一个参数或返回值。注释以类似 @ 的符号开始，然后是该参数或返回值的名称，后跟更多细节和描述。
例如，在 add 函数注释中，使用 @param 注释了两个参数 a 和 b，还使用 @returns 注释了返回值。
结束语
本文介绍了 doxie-core 包的使用方法。通过 doxie-core，可以很方便地创建并生成 JavaScript 文件的文档，提高代码共享和团队协作的效率。
查看文档，能够更清楚地了解如何使用 doxie-core，也可以发掘它的深度和学习指导意义。
在此基础上，您可以继续探索更多 JavaScript 文档生成工具和技术，进一步提高开发效率。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/5efedc25403f2923b035bbf2