在前端开发过程中，可能需要将代码文档化以方便阅读和理解。而 esdoc-publish-markdown-plugin 包就是一个优秀的 npm 包，可以帮助你将代码文档化为 Markdown 格式，方便进行阅读和共享。
安装
使用 npm 安装 esdoc-publish-markdown-plugin：
npm install esdoc-publish-markdown-plugin --save-dev
配置
在 esdoc.json 配置文件中添加以下内容：
-- -------------------- ---- -------
-
---------- -
-
------- --------------------------------
--------- -
-------------- --------
-
-
-
-其中 destination 表示将生成的 Markdown 文件输出至 ./docs 路径。
使用
在终端执行以下命令：
npx esdoc
然后就可以在 ./docs 路径下看到生成的 Markdown 文件，包括类和函数的详细文档。
示例
下面我们以一个简单的函数为例演示如何使用 esdoc-publish-markdown-plugin 进行文档生成。
-- -------------------- ---- ------- --- - --- --- ------- -------- - ------ -------- ---- - ------ -------- ---- - -------- -------- --- -- ---- --- ---- -- -------- --------- ----- - ------ ---- - ----- -
首先，我们需要使用 JSDoc 注释来对函数进行文档化，我们在注释中描述了该函数需要传入两个数字参数，并将两个数字相加并返回结果。
接下来，我们按照上面的配置添加 esdoc.json 文件，然后在终端中执行 npx esdoc 命令。
最后，在 ./docs 路径下就可以看到生成的 Markdown 文件，其中包含函数的详细文档。
结论
通过本文，我们了解了如何使用 esdoc-publish-markdown-plugin 包将代码文档化为 Markdown 格式，方便代码的阅读与共享。在日常的前端开发中，代码文档化是一个很重要的工作，它可以使得新手更快的理解代码，同时也让代码的交接与维护更加容易。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/57916
