我可以在 documentationjs 中导出类型并在 @param 中以引用类型导出 link 吗？

Question

我想做的是这样的：

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

然后当我将此类型用作参数时，记录它：

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

我尝试分配一个 returns 具有 organizationId 字符串类型的对象的函数。它确实有效，但需要花费大量时间来编辑我当前的代码库。

有没有办法导出类型并将其用作参数的类型引用？

我运行文档 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 可用。可能有用。

Can I export type in documentationjs and link it in a reference type in @param?