typescript - 如何在打字稿中记录联合类型？

Question

如何在打字稿中记录联合类型，以便typedoc提取/显示相关信息？下面是一份 JSDoc 参考资料，但是否有 TSDoc 参考资料？

例子

/**
 * Search parameters
 * These comments are not picked up, I generate blank page
 */
export type SearchParams = string | string[][] | Record<string, string>;

/**
 * Query parameters
 * These comments are not picked up, I generate blank page 
 */
export type QueryParams = SearchParams | Record<string, string | string[]>;

它们只是因为导出而被提取，但没有生成任何信息。( docfx@2.56.6, typedoc@0.19.2, type2docfx@0.10.5)

编辑：有什么方法可以使用上面的工具为这些类型生成文档？

Answer 1

看起来不管我们放什么评论，DocFx 都无法为类型别名和函数生成页面，而只能为类、接口等生成页面……至少在指定版本中。

我通过检查生成的*.json输出文件和结果*.yml文件确认了这一点。所有提到的文件都包含元数据，但 docfx 没有以正确的方式为它们生成 html 页面。

现在我只使用typedocwithtypedoc-plugin-markdown来生成文档，并且它以自己的能力正常工作。