Question

简短版本 如果我想从头开发一个全新的jsDoc模板，我需要阅读什么来理解jsDoc的作用，我的模板必须提供什么接口以及我可以使用哪些数据？

长版： 我一直在使用jsDoc一段时间，并且遇到了一些我想要添加的标签和我希望从我的文档中生成的概述页面。到目前为止，我使用usejsdoc.org解决了所有“用户问题”。我甚至设法添加了一个新的jsdoc插件，添加了一些标签。但是，我找不到关于如何为jsdoc创建模板的任何开发人员文档。我使用ink-docstrap所以我点击了模板文件夹（publish.js，/ tmpl等）的方式，并以某种方式了解了一切是如何工作的。但它非常耗时。

我应该阅读什么才能成为jsDoc模板专业人士？

Answer 1

These instructions是我能找到的最接近的地方：

创建或使用您自己的模板：
创建一个与模板同名的文件夹（例如，mycooltemplate）。

在模板文件夹中，创建名为publish.js的文件。此文件必须是导出名为publish。
的方法的CommonJS模块
例如：
/** @module publish */

/**
 * Generate documentation output.
 *
 * @param {TAFFY} data - A TaffyDB collection representing
 *                       all the symbols documented in your code.
 * @param {object} opts - An object with options information.
 */
exports.publish = function(data, opts) {
    // do stuff here to generate your output files
};
要使用您自己的模板调用JSDoc 3，请使用-t命令行选项，并指定模板文件夹的路径：
./jsdoc mycode.js -t /path/to/mycooltemplate

如果做不到，你可以read the source code！

Answer 2

我刚刚发布了自己的新jsdoc主题。我所做的只是简单地复制了默认模板：https://github.com/jsdoc3/jsdoc/tree/master/templates/default，并对此进行了处理。

我还设法通过以下功能添加咕unt声： *反编译+缩小js文件 *解析sass样式并将其最小化 *当您更改某些内容时刷新文档

您可以在此处查看其工作方式：https://github.com/SoftwareBrothers/better-docs

Answer 3

您可以自定义现有模板之一（默认、haruki 或无声）：

进入 node_modules/jsdoc/template 并将它们抓取到您在 node_modules 外的应用目录中。
随意将目录重命名为：jsdoc-template。
open jsdoc-template 根据需要更新/自定义内容。
例如：打开 publish.js 找到 Home 并替换 My Js App。
通过添加以下内容更新 jsdoc.json：

"opts": {
  "template": "jsdoc-template"
}

另一种使用其中一个模板的选项：jsdoc3 template list examples

是否有关于如何创建自己的jsdoc模板的详细文档？

3 个答案: