是否可以在documentationjs中导出类型并将其链接到@param中的引用类型中？

Question

我想做的事情如下所示：

/**
* @class OrganizationDescriptor
*/
export type OrganizationDescriptor = {|
  organizationId: string
|};

然后，当我使用此类型作为参数时，将其记录下来：

/**
* @param {OrganizationDescriptor} descriptor.organizationId returns {@link OrganizationDescriptor}
*/

我尝试分配一个函数，该函数返回一个organizationId字符串类型的对象。它确实可以工作，但它需要花费大量时间来编辑我当前的代码库。

是否有一种方法可以导出类型并将其用作参数的类型引用？

我运行documentation v12.1.4，并使用Node.js运行它

Answer 1

好吧，答案很简单。我所要做的就是转换类型文件，并向类型中添加一些文本。

就像这样，

/**
  * OrganizationDescriptor description
*/
export type OrganizationDescriptor = {|
  organizationId: string
|};

并将其用作

 /**
   * @param {object} descriptor
   * @param {OrganizationDescriptor} descriptor.organizationId 
 */
 info(descriptor: ActivityDescriptor) {

对我很管用。

你也不应该忘记@type namepath是可用的。可能会有用。