简介
在前端开发中，我们经常会用到 JSDoc 来为项目的代码生成文档，用来方便维护以及协作。然而 JSDoc 默认的模板并不美观，这时候我们需要用到 npm 包 jsdoc-template 来自定义模板。
在本文中，你将了解到如何使用 jsdoc-template 简单地定制自己的 JSDoc 模板，并且了解如何在项目中使用它，同时提高你编写文档的经验和能力。
安装和使用
首先，我们需要先安装 jsdoc-template：
npm install jsdoc-template
使用 jsdoc-template 很简单，我们只需要在命令行中指定使用它即可：
jsdoc -c path/to/conf.json -t node_modules/jsdoc-template
这里，-c 指定了需要用到的配置文件，-t 则指定了使用的模板。
定制自己的模板
接下来，我们就可以开始定制自己的模板了。首先，我们需要将 jsdoc-template 的默认模板直接复制到我们自己的项目中，然后在此基础上进行修改。
在我的项目中，我将模板存放在了这样的目录下：/docs/jsdoc-template。
接下来看下示例代码：
-- -------------------- ---- -------
--------- -----
----- ----------
------
----- ----------------
---------- ----- ----------
----- ---------------- --------- ----------------------------- ----
-------
------
------- ----- -------
--------------------
--- ----------- --
------------
--- ----------------
--- -------- --
-----
-------
------- -------- ---------------------------- -------------
-------这是 jsdoc-template 默认的模板，我们可以看到这是一个 HTML 文件，并且使用了 EJS 语法。我们可以在此基础上进行修改以达到自己的需求。
使用自己的模板
当我们完成模板的定制后，就可以在项目中使用它了。具体来说，在使用 JSDoc 生成文档时，我们只需要通过 -t 指定我们自己的模板就可以了。
jsdoc -c path/to/conf.json -t path/to/template
结束语
通过本文，你已经了解到了如何使用 npm 包 jsdoc-template 定制自己的 JSDoc 模板，并且学会了如何在项目中使用它。
不仅如此，本文还对编写文档时的思路和方法进行了一些探讨，希望对你在编写文档时能够起到一定的指导意义。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/57912