介绍
@jeremyckahn/minami 是一个简约的 JSDoc 主题，具有优美的排版和易用性，支持自定义样式和字体的个性化定制。使用它可以极大地提高代码文档的可读性和美观度。
安装
安装 minami 主题只需要通过 npm 把它安装到你的项目中即可。
npm install --save-dev @jeremyckahn/minami
使用
配置 JSDoc
在你的项目中增加一个 doc 目录，然后在目录中创建一个配置文件 jsdoc.json。
-- -------------------- ---- -------
-
---------- ---------------------
--------------- ---
--------- -
---------- -
------
-----------
--
---------- -
--------------
--
----------------- -------------
----------------- ---------------
--
------------- ---------
------- -
------------------- -----
--------------- -
--------
---------
-
--
------- -
-------------- --------
----------- ------------------------------------
--
------------ -
------------------ --- -----
-------------- --- --- -----
-
-运行 JSDoc
通过命令行来运行 JSDoc，从而生成文档。
./node_modules/.bin/jsdoc --configure ./doc/jsdoc.json
自定义样式
如果你想自定义主题的样式，并覆盖默认配置，只需要在项目的 jsdoc.json 文件中添加样式选项即可。
-- -------------------- ---- -------
-
------- -
-------------- --------
----------- -------------------------------------
------------ ------------------------
--------- -
--------- -----------
---------- -----------
-------- -
------------ --------- ---- ------
-------------- --------- ---- ------
--------- --------- ---- ------
------- -------- --- -----
------- --------- ---- -----
------------ --------- ---- ------
-------------- -------- --- -----
-------------- -------- ---- ------
-------------------- --------- ---- -----
--------------- ----------
------------------ ------- -- ----
--------- --------- ---- ------
------------ -------- --- -----
---------- -------- --- -----
---------- -------- --- -----
---------- -------- --- -----
---------- -------- --- -----
---------- -------- --- -----
---------- -------- --- -----
------------ -- --- ---- ------- -- -- ------
--------------------- ---------
-
-
-
-其中，minami 是自定义的配置项，下面的样式可以按照自己的需要进行定制。
示例代码
建议在代码中使用 JSDoc 注释。
-- -------------------- ---- -------
---
- ---------- - -----
- ------------
- ------ -------- ----- - --- ----- -- --- -----
- ------ -------- ------ - --- ------ -- --- -----
--
-------- ----------- ------- -
---------- - ------
----------- - -------
---
- ---- --- ----- -- --- -----
- -------- --------
--
------------- - ---------- -
------ -----------
--
-
-- ----
--- ------ - --- ----------- -------- ----- ----------
-------------------------------结尾
使用 @jeremyckahn/minami 主题可以从代码文档化的角度着手，提高前端应用的可维护性和可读性。同时，在个性化样式和配置上也可以根据项目特点进行灵活调整。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/5eedaf67b5cbfe1ea061101c