【问题标题】:ES 2015 related features and templatesES 2015 相关功能和模板
【发布时间】:2017-10-11 09:28:33
【问题描述】:

i) 可以在模板中实现继承层次结构吗?

ii) 我看到的所有列表方法的模板都是按字母顺序排列的,它们可以按照与源代码中相同的顺序列出吗? (我很欣赏这对于 ES5 并不是特别需要,但是对于 ES 2015 现在具有类似 OOP 语义的语言,我认为它或多或少是标准的。)

通过早期的方式,例如的 JSDoc3 在野外生成 ES 2015 文档(并说明我的观点),https://bitbucket.org/gso/eonjs/src/(滚动到“支持”)。

【问题讨论】:

  • Reg i) - 你已经可以使用 @extends 来标记继承,也许你可以澄清你到底缺少什么。 ii) 你有没有看过一个模板以及事情是如何完成的?
  • 我已经快速浏览了一个模板(虽然还没有确切地知道从解析器传回的信息),需要一些编码,但应该是可能的。还需要考虑模块语法。这是我最终查看的文档...code.google.com/p/jsdoc-toolkit/wiki/Templates
  • 请注意,这是“旧”的 jsdoc,请考虑改用 jsdoc3 - 整体流程类似,但 API 和模板引擎不同。我基本上只是查看默认模板,复制它并为我的目的进行调整。如果您查看 publish.js,您将看到它是如何在 buildNav() 中生成菜单的。
  • 除了源代码之外,还有新版JSDoc3的文档吗?
  • 该文档位于usejsdoc.org 并且对于那里的内容非常好,但是似乎缺少模板。 :-/

标签: jsdoc jsdoc3


【解决方案1】:

jsdoc3 支持 es5 类继承,但有时它取决于您使用的模板。我使用几个模板生成了一个输出,因此我们可以根据自己的需要比较哪个最合适:https://cancerberosgx.github.io/jsdoc-templates-demo/demo/我会随着时间的推移投入更多,但我认为这对做出决定很有帮助。它还记录了它们中的每一个是如何生成的。希望对您有所帮助!

【讨论】:

    猜你喜欢
    • 1970-01-01
    • 2010-09-08
    • 1970-01-01
    • 2017-08-20
    • 2011-03-27
    • 2010-12-14
    • 1970-01-01
    • 2022-01-05
    • 2015-08-08
    相关资源
    最近更新 更多