【问题标题】:JSDoc - Document Object of typeJSDoc - 类型的文档对象
【发布时间】:2021-09-10 23:24:45
【问题描述】:

在 JSDoc 中,如何记录某个已定义类型的 Object?

例如,如果我有一个接收HTMLImageElement 对象的函数,我应该如何在参数中记录它?

会不会像@param {HTMLImageElement} - An image@param {Object<HTMLImageElement>} 一样?

【问题讨论】:

  • 你已经回答了你的问题@param {HTMLImageElement} - An image这是正确的。

标签: javascript parameters documentation jsdoc


【解决方案1】:

你提到的第一个选项是正确的:

@param {HTMLImageElement} An image

所有类/对象类型都可以用作类型参数中的类型。你不需要对它们做任何花哨的事情。

而且由于所有类实例都是对象,所以你知道它也是一个对象。

【讨论】:

    猜你喜欢
    • 2019-01-29
    • 2018-12-07
    • 1970-01-01
    • 2021-03-25
    • 2013-10-14
    • 1970-01-01
    • 2020-03-11
    • 1970-01-01
    相关资源
    最近更新 更多