简介
@jesterxl/hm-doc 是一个用于生成前端文档的 npm 包，它能够自动生成 Markdown 格式的注释文档，并将其转化为静态 HTML 页面。它可以大大减少手写文档的工作量，提高代码可读性。
安装
npm install -g @jesterxl/hm-doc
使用方法
1. 在代码中添加注释
在代码中添加注释，使用特定格式，方便 @jesterxl/hm-doc 进行识别。
-- -------------------- ---- ------- --- - ---- - - ------ -------- - - ----- - ------ -------- - - ----- - ------- -------- --------- - - -------- - - ------ -- -- -- - -- -------- --- --- -- - ------ - - - -
2. 使用 @jesterxl/hm-doc 生成文档
使用以下命令生成文档：
hm-doc <path to your code>
3. 处理结果
在执行完毕后，@jesterxl/hm-doc 会默认生成以下目录：
/path/to/your/code/docs ├── api.md // API 文档 └── index.html // 首页
您可以在 docs 目录下找到自动生成的 Markdown 和 HTML 文件。
配置文件
您可以在项目根目录下新建 hm-doc.config.js 文件，来配置 @jesterxl/hm-doc 的一些选项。
-- -------------------- ---- -------
-------------- - -
------ ----------- -- -------
------- --------- -- -------
--------- ------------------------- -- -------
------ --- ------ -- -------
---- ------- --------- -- -------
------- ------------- -- -------
---------- - -- ----------- --
---- -----
------- -----
------- ----
--
------------ - -- ------- --
----- --------
------ --- -----
--
------- ---------- -- ----------------- -- -----
-示例
我们来看一个生成文档的示例：
-- -------------------- ---- ------- --- - ---- - - ------ -------- - - ----- - ------ -------- - - ----- - ------- -------- --------- - - -------- - - ----------- -- -- -- - -- -------- -------- --- -- - ------ - - - - --- - -- ----- ----- - - ------- -------- -- ----- ----- --- -- -------- ---------- -- - ------ ------ ------ -
执行如下命令：
hm-doc ./src/js
在执行完成后，@jesterxl/hm-doc 会默认生成以下目录：
./docs ├── api.md // API 文档 └── index.html // 首页
在浏览器中打开 index.html，可以看到页面内容如下：
总结
通过 @jesterxl/hm-doc，我们可以方便地生成前端代码的文档，提高代码可读性，减少手写文档的工作量。同时，配合配置文件，@jesterxl/hm-doc 还拥有对输出内容的更灵活的掌控。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/60066b4e51ab1864dac66884