@param 中的 JSDOC 数据类型答案

【问题标题】：JSDOC datatype in @param@param 中的 JSDOC 数据类型
【发布时间】：2016-09-19 22:11:51
【问题描述】：

在 jsdoc @param 中，

  We can write like:
   /**
     * @param {Object} somebody- The employee who is responsible.
     */
   function sayHello(somebody: ABC) {
        alert('Hello ' + somebody);
    }

如果我有一个像 ABC 这样的类并且有人是 ABC 类型的对象，我可以这样写吗？

   /**
     * @param {ABC} somebody- The employee who is responsible.
     */
   function sayHello(somebody: ABC) {
        alert('Hello ' + somebody);
    }

也就是说，我可以在 param 的花括号内给出我自己的对象类型，而不是作为对象给出吗？提前谢谢...

【问题讨论】：

标签： jsdoc3

【解决方案1】：

查看您的代码，您可能正在使用 TypeScript。你有两个选择：

如果 ABC 是一个对象或类，您可以使用 JSDoc 名称路径（例如：myNamespaceOrModule.ABC}；
如果 ABC 不是实际的 JavaScript 对象（例如：TypeScript 接口），那么您可以使用 JSDoc @typedef 标签来记录自定义标签。

请提供定义 ABC 类的代码以获得更好的答案。

【讨论】：