什么是jsdoc-template-argon
jsdoc-template-argon是一款基于 jsdoc 生成的文档模板，使用 Bootstrap、Font Awesome 和 Material Design Icons 进行优化和美化。该模板的优美和清晰的设计让你的代码文档更容易阅读，同时它也能自动生成 API 文档，并自动处理代码更改，保持文档的更新性。
安装
使用npm安装jsdoc-template-argon：
npm install jsdoc-template-argon --save-dev
配置
在jsdoc配置文件的目录中创建一个jsdoc.json文件，并添加以下内容：
-- -------------------- ---- -------
-
------- -
------------------- -----
--------------- --------- ----------
--
--------- -
----------------- -------------------
----------------- ---------------
--
---------- -
------------------
--
------------ -
-------------- ------
----------------- ------
---------- -
-------------------- -----
------------- -----------------------------------
-------------- -
---------- -
-----------------------------
-
-
-
--
------- -
----------- --------------------------------------
----------- -------
-------------- --------
---------- -----
---------- ----
-
-运行
运行jsdoc：
jsdoc -c ./jsdoc.json
文档将生成在docs目录。
示例代码
-- -------------------- ---- ------- --- - ------- - ------ -------- - - --- - ------ -------- - - -- - -------- -------- ----- - -------- - ------ --- -- - -- -------- ------ -- - ------ - - -- - --- - ------- - ------ -------- - - ----- - -------- -------- ----- - -------- - ---------- -- -- -- -------- --------- - ------ - - -- -
以上代码将生成以下API文档:
结论
jsdoc-template-argon 是一款美观、易于使用的文档生成工具。借助它的优美的设计，你可以轻松地为你的代码生成完美的文档，同时也可以保持文档的更新性以及代码的清晰。希望这篇文章对您来说有所帮助，如果有问题，请不要犹豫与我们联系。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/6005577f81e8991b448d47f8