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

Question

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

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

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

Answer 1

这些说明是我能找到的最接近的说明：

要创建或使用自己的模板，请执行以下操作：

1. 创建一个与模板名称相同的文件夹（例如，mycooltemplate）。
2. 在模板文件夹中，创建一个名为的文件publish.js。此文件必须是可导出名为的方法的CommonJS模块publish。

例如：

/** @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

失败的话，您可以阅读源代码！