短版:
如果我想从头开始开发一个全新的 jsDoc 模板,我需要阅读哪些内容才能了解 jsDoc 的功能、我的模板必须提供什么接口(interface)以及我可以使用哪些数据?
加长版:
我已经使用 jsDoc 一段时间了,遇到了一些我想添加的标签和我想从我的文档中生成的概述页面。到目前为止,我用 usejsdoc.org 解决了我所有的“用户问题”。 .我什至设法添加了一个新的 jsdoc 插件来添加一些标签。但是,我找不到任何有关如何为 jsdoc 创建模板的开发人员文档。我用 ink-docstrap所以我点击了模板文件夹(publish.js、/tmpl 等)并以某种方式了解了一切是如何工作的。但它非常非常耗时。
要成为 jsDoc 模板专家,我应该阅读什么内容?
请您参考如下方法:
由于缺乏文档,我遇到了类似的困难。有一个已开放 7 年的 GitHub 问题:Provide docs that explain how templates work .
到目前为止,我发现的唯一一个看起来不像默认的修改版本的自定义模板是 Ramda's documentation。 .看起来他们使用的是完全自定义的 publish.js script它使用 handlebars.js 而不是 underscore.js 模板,构建非分层导航,从 @sig 和 @category 标签中提取信息,并使用指向 github 的链接来“查看源代码”,而不是为源代码呈现自己的 html 页面。
他们的一些代码很难理解,除非你熟悉 Ramda 和函数式编程(他们在他们的 publish.js 版本中使用 Ramda 本身)但是转储了 data
的值和 docs
在执行期间应该有助于深入了解正在发生的事情。
他们的模板是 single file 也很有帮助。所以你不必在很多部分模板文件之间跳转来了解文档是如何构建的。